docs: добавлено правило писать коммиты и PR на русском
Единый понятный стиль истории для обоих разработчиков и AI-ассистентов. Тип и область остаются латиницей для инструментов (git-cliff, lefthook). Refs: 1.2.9 Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
1 parent
434becbba3
commit
e9a85ad1a4
2 files changed
+9
No files matched your search
@@ -113,6 +113,13 @@ shtil-roadmap.html дорожная карта
|
||||
### Общее
|
||||
- Термины — по `docs/glossary.md`. Новый термин сначала добавляется в словарь.
|
||||
- Ветки `feat/<ID>-кратко`, коммиты Conventional Commits с областью (`feat(server): …`) и строкой `Refs: <ID подзадачи>`, PR в Gitea «[ID] Название», squash merge.
|
||||
- **Коммиты и PR пишутся на русском языке, понятно и чётко.** Тип и область остаются латиницей (их читают инструменты), всё остальное — по-русски:
|
||||
- заголовок: `тип(область): что сделано` — с маленькой буквы, без точки, до 72 символов, глагол в прошедшем времени (`добавлен`, `исправлена`, `убрано`);
|
||||
- тело (если нужно): почему и что важно знать, а не пересказ диффа;
|
||||
- последняя строка: `Refs: <ID пункта>`.
|
||||
- Хорошо: `feat(server): добавлен WithTenantTx для доступа к данным организации`, `fix(console): исправлен повтор запроса после истечения токена`.
|
||||
- Плохо: `fix`, `правки`, `update files`, `WIP`, английский текст.
|
||||
- Заголовок squash-коммита при слиянии PR тоже по-русски, обычно совпадает с названием PR.
|
||||
- Изменения `api/openapi.yaml`, `proto/`, `migrations/` — отдельным PR.
|
||||
- Значимое техническое решение — ADR в `docs/adr/NNNN-название.md` и поле «Решение» в дорожной карте.
|
||||
- Без лишних комментариев: комментарий объясняет «почему», а не «что».
|
||||
|
||||
Reference in new issue
Block a user