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

docs: add conventional commits README.md

Browse Source
This commit is contained in:
Максим Бучнев
2025-05-31 13:20:00 +03:00
parent c5a7a49c3a
commit 0a65057d1d
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
conventional-commits/README.md Normal file
View File

@@ -0,0 +1,30 @@
# 🛠️ Conventional Commits
Conventional Commits — соглашение о формате сообщений коммитов
---
## 📝 Основные тезисы Conventional Commits
* Разработчик должен придерживаться следующей структуры коммитов:
```
<type>(<scope>): <subject>
<body>
<footer>
```
- У коммита должен быть **заголовок**, может быть тело и нижний колонтитул.
- Заголовок коммита должен начинаться с **типа** (_type_), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием. Примеры типов приведены на изображении:![[Pasted image 20241011153023.png]]
- Наряду с обязательными _feat_, _fix_ (использование которых строго регламентировано), допускаются и другие типы.
- У коммита может быть **область** (_scope_). Она характеризует фрагмент кода, которую затронули изменения. Область следует за типом коммита. Стандарт не регламентирует четкий список областей. Примеры областей: eslint, git, analytics и т.д.
- Описание коммита должно быть сразу после типа/области.
- **Тело коммита** может быть использовано для детализации изменений. Тело должно быть отделено от описания пустой строкой.
- **Нижний колонтитул** следует использовать для указания внешних ссылок, контекста коммита или другой мета информации. Нижний колонтитул должен быть отделен от тела пустой строкой.
- В Нижнем колонтитуле можно указать **BREAKING CHANGE** - изменение в коде, которое ломает обратную совместимость. То есть, после такого изменения код, который раньше работал с этим модулем/библиотекой/функцией, может перестать работать.
- Чтобы указать breaking change, нужно:
1. Добавить в описание **`BREAKING CHANGE:`** и пояснение;
2. Или поставить в типе коммита **восклицательный знак (`!`)**.
---
## 📝 Примеры
Примеры Conventional Commits можно увидеть в git log репозитория. Все коммиты были написаны с использованием CC.