Merge pull request 'docs: добавлено правило писать коммиты и PR на русском' (#2) from docs/1.2-commit-rules-ru into main
Reviewed-on: #2
This commit was merged in pull request #2.
This commit is contained in:
commit
3d9c84839e
2 files changed
+9
No files matched your search
@@ -113,6 +113,13 @@ shtil-roadmap.html дорожная карта
|
|||||||
### Общее
|
### Общее
|
||||||
- Термины — по `docs/glossary.md`. Новый термин сначала добавляется в словарь.
|
- Термины — по `docs/glossary.md`. Новый термин сначала добавляется в словарь.
|
||||||
- Ветки `feat/<ID>-кратко`, коммиты Conventional Commits с областью (`feat(server): …`) и строкой `Refs: <ID подзадачи>`, PR в Gitea «[ID] Название», squash merge.
|
- Ветки `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.
|
- Изменения `api/openapi.yaml`, `proto/`, `migrations/` — отдельным PR.
|
||||||
- Значимое техническое решение — ADR в `docs/adr/NNNN-название.md` и поле «Решение» в дорожной карте.
|
- Значимое техническое решение — ADR в `docs/adr/NNNN-название.md` и поле «Решение» в дорожной карте.
|
||||||
- Без лишних комментариев: комментарий объясняет «почему», а не «что».
|
- Без лишних комментариев: комментарий объясняет «почему», а не «что».
|
||||||
|
|||||||
@@ -106,6 +106,8 @@
|
|||||||
|
|
||||||
Документы коммитятся в той же ветке, что и код (`docs(<область>): …` или вместе с кодом), с той же строкой `Refs: <ID>`.
|
Документы коммитятся в той же ветке, что и код (`docs(<область>): …` или вместе с кодом), с той же строкой `Refs: <ID>`.
|
||||||
|
|
||||||
|
**Коммиты, названия и описания PR — только на русском** (правило в `AGENTS.md`, раздел 6): `тип(область): что сделано`, тип и область латиницей, остальное по-русски, понятно и конкретно. Ассистент сам предлагает сообщение коммита в этом формате и не использует английские шаблоны своего инструмента.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6. Форматы и размеры
|
## 6. Форматы и размеры
|
||||||
|
|||||||
Reference in new issue
Block a user