mbuchnev/methodologies
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(conventional-commits): update docs

Browse Source
This commit is contained in:
mbuchnev
2025-05-31 10:49:20 +00:00
parent 20b0487696
commit e2feebdcd7
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
conventional-commits/README.md
View File

@@ -14,7 +14,8 @@ Conventional Commits — соглашение о формате сообщени
``` ```
- У коммита должен быть **заголовок**, может быть тело и нижний колонтитул. - У коммита должен быть **заголовок**, может быть тело и нижний колонтитул.
- Заголовок коммита должен начинаться с **типа** (_type_), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием. - Заголовок коммита должен начинаться с **типа** (_type_), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием.
Примеры типов приведены на изображении:![CC types](/images/CC types.png) Примеры типов приведены на изображении:
![CC types](https://git.rdcenter.ru/mbuchnev/methodologies/raw/main/images/CC-types.png)
- Наряду с обязательными _feat_, _fix_ (использование которых строго регламентировано), допускаются и другие типы. - Наряду с обязательными _feat_, _fix_ (использование которых строго регламентировано), допускаются и другие типы.
- У коммита может быть **область** (_scope_). Она характеризует фрагмент кода, которую затронули изменения. Область следует за типом коммита. Стандарт не регламентирует четкий список областей. Примеры областей: eslint, git, analytics и т.д. - У коммита может быть **область** (_scope_). Она характеризует фрагмент кода, которую затронули изменения. Область следует за типом коммита. Стандарт не регламентирует четкий список областей. Примеры областей: eslint, git, analytics и т.д.
- Описание коммита должно быть сразу после типа/области. - Описание коммита должно быть сразу после типа/области.