From 402ab0e48140d4df311f7d789af8b337a2f21c10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9C=D0=B8=D1=85=D0=B0=D0=B8=D0=BB?= Date: Fri, 11 Jan 2019 11:40:36 +0300 Subject: [PATCH] =?UTF-8?q?[ANY]=20=D0=A1=D0=BE=D0=B1=D1=81=D1=82=D0=B2?= =?UTF-8?q?=D0=B5=D0=BD=D0=BD=D0=B0=D1=8F=20Git=20=D0=BA=D0=BE=D0=BD=D0=B2?= =?UTF-8?q?=D0=B5=D0=BD=D1=86=D0=B8=D1=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- GITCONVENTION.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 GITCONVENTION.md diff --git a/GITCONVENTION.md b/GITCONVENTION.md new file mode 100644 index 00000000..b5bc7406 --- /dev/null +++ b/GITCONVENTION.md @@ -0,0 +1,42 @@ +# GravitLauncher GitConvention # +Цель конвенции — внедрить простые, прозрачные и эффективные правила работы с Git. + +Разработка GravitLauncher идёт на базе [Git Flow](https://leanpub.com/git-flow/read). Подробности ниже. + +## Ветвление ## + +| Название ветки | Значение ветки | Исходная ветка | Пример ветки | +| ------------- | ------------- | ------------- | ------------- | +| **master** | Полностью готовая для production-а | **release** | | +| **develop** | Разработка нового функционала | **master** | | +| **release** | Тестирование всего нового функционала | **develop** | | +| | | | | +| **bugfix-*** | Исправляет баг нового функционала | **release** | *bugfix-auth* | +| **feature-*** | Добавляет новую возможность | **develop** | *feature-auth* | +| **hotfix-*** | Вносит срочное исправление для production-а | **master** | *hotfix-auth* | +----- +![Image of GitFlow](https://i.ytimg.com/vi/w2r0oLFtXAw/maxresdefault.jpg) +----- + +## Коммиты ## +**Основные правила:** +1. Все коммиты должны быть на русском языке. +2. Запрещено использовать прошедшее время. +3. Обязательно должен быть использован префикс. +4. В конце не должно быть лишнего знака препинания. +5. Длина любой части не должна превышать 100 символов. + +**Структура:** +``` +[Префикс] <Сообщение> +``` + +| Префикс | Значение | Пример | +| ------- | -------- | ------ | +| **[FIX]** | Всё, что касается исправления багов | [FIX] Баг с неудачной авторизацией | +| **[DOCS]** | Всё, что касается документации | [DOCS] Документирование API авторизации | +| **[FEATURE]** | Всё, что касается новых возможностей | [FEATURE] 2FA при авторизации | +| **[STYLE]** | Всё, что касается опечаток и форматирования | [STYLE] Опечатки в модуле авторизации | +| **[REFACTOR]** | Всё, что касается рефакторинга | [REFACTOR] Переход на EDA в модуле авторизации | +| **[TEST]** | Всё, что касается тестирования | [TEST] Покрытие модуля авторизации тестами | +| **[ANY]** | Всё, что не подходит к предыдущему. | [ANY] Подключение Travis CI |