CONTRIBUTING - main - verse_coder/java-finance-tracker

CONTRIBUTING
27 строк2 KB
verse_coder
Create: CONTRIBUTING
07 июн 2026, 12:40
07 июн 2026, 12:408243c5b
# Руководство по внесению вклада (Contributing Guide)

Рады, что вы хотите помочь улучшить наш финансовый трекер! Вот простые правила, которые помогут сделать это правильно и быстро.

## 🛠 Как начать

1. Сделайте форк (Fork) этого репозитория на GitVerse.
2. Склонируйте его на свой компьютер и откройте в любой IDE (рекомендуется GigaIDE или IntelliJ IDEA).
3. Убедитесь, что у вас установлена **Java 17** или выше.

## 🌿 Правила работы с ветками

Пожалуйста, не отправляйте изменения напрямую в ветку `main`. Создавайте для каждой задачи отдельную ветку с понятным названием:
* Для новых функций: `feature/название-фичи` (например, `feature/save-to-file`)
* Для исправления багов: `bugfix/название-бага` (например, `bugfix/fix-scanner`)

## 📝 Требования к коду

* **Понятность:** Пишите чистый код. Если логика сложная, добавляйте комментарии на русском языке.
* **Форматирование:** Перед отправкой кода используйте встроенное форматирование в IDE (в GigaIDE это комбинация клавиш `Cmd + Option + L` на Mac).
* **Работоспособность:** Проверьте программу локально перед отправкой — она должна успешно компилироваться и запускаться без ошибок.

## 🚀 Оформление запроса (Pull Request)

1. Отправьте свою ветку в свой форк на GitVerse.
2. Создайте **Pull Request** в наш основной репозиторий.
3. Опишите в свободной форме, что именно вы изменили или улучшили. Мы постараемся проверить его как можно скорее!