doc: Added commit convention tag
This commit is contained in:
parent
8e2359c99a
commit
73c0ec5fb5
23
doc/convention.md
Normal file
23
doc/convention.md
Normal file
@ -0,0 +1,23 @@
|
||||
### Список тегов (типов коммитов) :
|
||||
|
||||
| Тег (на английском) | Перевод / Описание на русском |
|
||||
| :--- | :--- |
|
||||
| **feat** | **feat (функциональность)**: Новая функция или значительная функциональность. |
|
||||
| **fix** | **fix (исправление)**: Исправление ошибки (бага). |
|
||||
| **style** | **style (стиль)**: Изменения, не влияющие на логику кода (форматирование, пробелы и т.д.). |
|
||||
| **chore** | **chore (техническая работа)**: Рутинные задачи, обслуживание (обновление зависимостей, настройка инструментов). |
|
||||
| **test** | **test (тестирование)**: Добавление или изменение тестов. |
|
||||
| **docs** | **docs (документация)**: Изменения в документации. |
|
||||
| **refactor** | **refactor (рефакторинг)**: Изменения структуры кода без изменения его поведения. |
|
||||
| **perf** | **perf (производительность)**: Изменения, направленные на улучшение производительности. |
|
||||
| **build** | **build (сборка)**: Изменения, влияющие на систему сборки или внешние зависимости. |
|
||||
| **ci** | **ci (непрерывная интеграция)**: Изменения в конфигурации непрерывной интеграции (CI). |
|
||||
| **revert** | **revert (откат)**: Откат предыдущего коммита. |
|
||||
|
||||
### Ключевой формат сообщения коммита:
|
||||
|
||||
Согласно правилам из статьи, полное сообщение коммита должно следовать такому формату:
|
||||
`"[ID-ЗАДАЧИ]-[ТИП]: Описание"`
|
||||
|
||||
**Пример:** `BC1-07-feat: Add user authentication page` (Добавить страницу аутентификации пользователя).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user