mirror of
https://github.com/GravitLauncher/Launcher
synced 2024-11-15 11:39:11 +03:00
2.9 KiB
2.9 KiB
GravitLauncher GitConvention
Цель конвенции — внедрить простые, прозрачные и эффективные правила работы с Git.
Разработка GravitLauncher идёт на базе Git Flow. Подробности ниже.
Ветвление
Название ветки | Значение ветки | Исходная ветка | Пример ветки |
---|---|---|---|
master | Полностью готовая для production-а | release | |
develop | Разработка нового функционала | master | |
release | Тестирование всего нового функционала | develop | |
bugfix-* | Исправляет баг нового функционала | release | bugfix-auth |
feature-* | Добавляет новую возможность | develop | feature-auth |
hotfix-* | Вносит срочное исправление для production-а | master | hotfix-auth |
Коммиты
Основные правила:
- Все коммиты должны быть на русском языке.
- Запрещено использовать прошедшее время.
- Обязательно должен быть использован префикс.
- В конце не должно быть лишнего знака препинания.
- Длина любой части не должна превышать 100 символов.
Структура:
[Префикс] <Сообщение>
Префикс | Значение | Пример |
---|---|---|
[FIX] | Всё, что касается исправления багов | [FIX] Баг с неудачной авторизацией |
[DOCS] | Всё, что касается документации | [DOCS] Документирование API авторизации |
[FEATURE] | Всё, что касается новых возможностей | [FEATURE] 2FA при авторизации |
[STYLE] | Всё, что касается опечаток и форматирования | [STYLE] Опечатки в модуле авторизации |
[REFACTOR] | Всё, что касается рефакторинга | [REFACTOR] Переход на EDA в модуле авторизации |
[TEST] | Всё, что касается тестирования | [TEST] Покрытие модуля авторизации тестами |
[ANY] | Всё, что не подходит к предыдущему. | [ANY] Подключение Travis CI |