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

refactor(conventional-commits): improve docs readability

Browse Source
This commit is contained in:
mbuchnev
2025-05-31 11:43:12 +00:00
parent c7feab7aec
commit b9fcb6ff9a
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
conventional-commits/README.md
View File

@@ -12,16 +12,16 @@ Conventional Commits — соглашение о формате сообщени
<footer> <footer>
``` ```
- У коммита должен быть **заголовок**, может быть тело и нижний колонтитул. - У коммита должен быть `заголовок`, может быть тело и нижний колонтитул.
- Заголовок коммита должен начинаться с **типа** (_type_), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием. - Заголовок коммита должен начинаться с `типа` (_type_), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием.
Примеры типов приведены на изображении: Примеры типов приведены на изображении:
![CC types](https://git.rdcenter.ru/mbuchnev/methodologies/raw/main/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 и т.д.
- Описание коммита должно быть сразу после типа/области. - Описание коммита должно быть сразу после типа/области.
- **Тело коммита** может быть использовано для детализации изменений. Тело должно быть отделено от описания пустой строкой. - `Тело коммита` может быть использовано для детализации изменений. Тело должно быть отделено от описания пустой строкой.
- **Нижний колонтитул** следует использовать для указания внешних ссылок, контекста коммита или другой мета информации. Нижний колонтитул должен быть отделен от тела пустой строкой. - `Нижний колонтитул` следует использовать для указания внешних ссылок, контекста коммита или другой мета информации. Нижний колонтитул должен быть отделен от тела пустой строкой.
- В Нижнем колонтитуле можно указать **BREAKING CHANGE** - изменение в коде, которое ломает обратную совместимость. То есть, после такого изменения код, который раньше работал с этим модулем/библиотекой/функцией, может перестать работать. - В Нижнем колонтитуле можно указать `BREAKING CHANGE` - изменение в коде, которое ломает обратную совместимость. То есть, после такого изменения код, который раньше работал с этим модулем/библиотекой/функцией, может перестать работать.
- Чтобы указать breaking change, нужно: - Чтобы указать breaking change, нужно:
1. Добавить в описание **`BREAKING CHANGE:`** и пояснение; 1. Добавить в описание **`BREAKING CHANGE:`** и пояснение;
2. Или поставить в типе коммита **восклицательный знак (`!`)**. 2. Или поставить в типе коммита **восклицательный знак (`!`)**.