From 73c0ec5fb50c56eb5b2f83ad33402f68f32d6ec1 Mon Sep 17 00:00:00 2001 From: vitaliy Date: Mon, 15 Dec 2025 14:23:24 +0300 Subject: [PATCH] doc: Added commit convention tag --- doc/convention.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 doc/convention.md diff --git a/doc/convention.md b/doc/convention.md new file mode 100644 index 0000000..1faa171 --- /dev/null +++ b/doc/convention.md @@ -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` (Добавить страницу аутентификации пользователя). +