docs(skills): обновлен шаблон conventional-commits под markdown-список

- Зачем:
  - привести формат commit body к виду, который используется в репозитории и ожидается в UI.
- Что:
  - заменен плоский шаблон `Зачем/Что/Проверка` на markdown-список с подпунктами.
  - добавлены явные требования к структуре тела коммита и количеству пунктов.
  - обновлены примеры и heredoc-шаблон под новый формат.
- Проверка:
  - git log -1 --pretty=format:'%s%n%n%b'.
  - проверить, что секции выводятся как list в UI.
This commit is contained in:
ddadmin committed 2026-02-21 21:12:44 +03:00
1 parent 410e543ade
commit f34e638084
1 file changed
+44 -18
@@ -20,10 +20,20 @@ description: "ОБЯЗАТЕЛЬНО вызывай этот навык кажд
* Грамматика (Английский): повелительное наклонение (add, fix, update). Без точки в конце.
* Технические термины (SQL, DWH, PostgreSQL, Airflow) не переводи.
# Шаблон тела коммита (Плоская структура)
Зачем: [Бизнес-причина или техническая необходимость]
Что: [Ключевые изменения]
Проверка: [Как проверить: команда, тест или скрипт]
# Шаблон тела коммита (Markdown-список)
- Зачем:
- [Бизнес-причина или техническая необходимость]
- Что:
- [Ключевое изменение 1]
- [Ключевое изменение 2, если есть]
- Проверка:
- [Как проверить: команда, тест или скрипт]
Требования к телу:
* Всегда используй именно список с маркерами `-`, как в шаблоне выше.
* Обязательные секции: `Зачем`, `Что`, `Проверка`.
* Внутри каждой секции минимум 1 подпункт.
* В секции `Что` обычно 1-3 подпункта с фактами по diff.
# Строгое правило форматирования (Анти-экранирование)
КАТЕГОРИЧЕСКИ ЗАПРЕЩЕНО использовать литералы `\n`, `\r`, `\t` в тексте коммита. Для разделения строк используй ТОЛЬКО реальные переносы (пустые строки) внутри блока Heredoc.
@@ -32,8 +42,10 @@ description: "ОБЯЗАТЕЛЬНО вызывай этот навык кажд
Зачем: текст.\nЧто: текст.
ПРАВИЛЬНО:
Зачем: текст.
Что: текст.
- Зачем:
- текст.
- Что:
- текст.
# Правила выполнения команд
ЗАПРЕЩЕНО использовать флаги `-m`. РАЗРЕШЕНО использовать только формат передачи через Heredoc:
@@ -41,9 +53,12 @@ description: "ОБЯЗАТЕЛЬНО вызывай этот навык кажд
git commit -F- <<'EOF'
<type>(<scope>): <описание>
Зачем: <текст>
Что: <текст>
Проверка: <текст>
- Зачем:
- <текст>
- Что:
- <текст>
- Проверка:
- <текст>
EOF
# Идеальные примеры
@@ -52,25 +67,36 @@ EOF
git commit -F- <<'EOF'
feat(sql): добавлен скрипт валидации данных для DWH слоя
Зачем: необходима проверка целостности и уникальности перед загрузкой в хранилище.
Что: создан файл 04_validation.sql, добавлены проверки на NULL.
Проверка: psql -f dwh-modeling/sql/04_validation.sql.
- Зачем:
- необходима проверка целостности и уникальности перед загрузкой в хранилище.
- Что:
- создан файл 04_validation.sql.
- добавлены проверки на NULL.
- Проверка:
- psql -f dwh-modeling/sql/04_validation.sql.
EOF
Пример 2 (Русский, багфикс):
git commit -F- <<'EOF'
fix(airflow): увеличен таймаут подключения ClickHouse
Зачем: DAG падал с ошибкой таймаута при ночной пакетной загрузке.
Что: параметр conn_timeout изменен с 30 до 120 секунд.
Проверка: тестовый запуск таски в Airflow UI.
- Зачем:
- DAG падал с ошибкой таймаута при ночной пакетной загрузке.
- Что:
- параметр conn_timeout изменен с 30 до 120 секунд.
- Проверка:
- тестовый запуск таски в Airflow UI.
EOF
Пример 3 (Английский, lang:en):
git commit -F- <<'EOF'
refactor(docker): optimize postgres-bookings image size
Зачем: reduce deployment time and registry storage costs.
Что: switched base image to alpine, removed intermediate build artifacts.
Проверка: docker build and check image size.
- Зачем:
- reduce deployment time and registry storage costs.
- Что:
- switched base image to alpine.
- removed intermediate build artifacts.
- Проверка:
- docker build and check image size.
EOF