Dmitry Dementiev
fa90b2e817
- Зачем: сохранён общий стиль сообщений без избыточных ограничений для модели. - Что: тело стало гибким, уточнены условия вызова и требования к amend; убраны повторения и пошаговые инструкции. - Проверка: quick_validate.py и git diff --check пройдены.
38 lines
2.6 KiB
Markdown
38 lines
2.6 KiB
Markdown
---
|
|
name: conventional-commits
|
|
description: "Формат сообщений Conventional Commits. Применяй при создании коммита, amend или подготовке сообщения коммита."
|
|
---
|
|
|
|
# Формат сообщения
|
|
|
|
## Заголовок
|
|
|
|
- Формат: `<type>(<scope>): <описание>`. Указывай scope, когда он помогает обозначить область изменения.
|
|
- Типы: feat, fix, refactor, docs, test, chore, ci, perf, build, revert.
|
|
- До 72 символов, без точки в конце.
|
|
- По умолчанию пиши по-русски, в совершенном виде и прошедшем времени: «добавлено», «исправлено». Если нужен английский — используй повелительное наклонение: add, fix, update.
|
|
|
|
## Тело
|
|
|
|
Для простой правки достаточно заголовка. Когда нужны подробности, ориентируйся на короткий список «Зачем / Что / Проверка»:
|
|
|
|
- Зачем: причина изменения из контекста задачи.
|
|
- Что: существенные изменения, которые дополняют заголовок.
|
|
- Проверка: что проверено и с каким результатом; предложенную проверку явно обозначай как ещё не выполненную.
|
|
|
|
Сохраняй этот порядок и названия там, где они уместны. Включай только содержательные пункты; объём пояснений соразмеряй изменению. Если причина неизвестна, опирайся на подтверждённые факты.
|
|
|
|
Пример:
|
|
|
|
```text
|
|
fix(airflow): увеличен таймаут подключения ClickHouse
|
|
|
|
- Зачем: ночная загрузка прерывалась по таймауту подключения.
|
|
- Что: conn_timeout увеличен с 30 до 120 секунд.
|
|
- Проверка: ещё не выполнена; нужен тестовый запуск DAG.
|
|
```
|
|
|
|
## Amend
|
|
|
|
Сообщение описывает весь итоговый состав коммита. Перепиши его как единое целое; сохраняй исходную причину, пока она соответствует изменениям. Сведения о проверках должны относиться к итоговой версии.
|