pavelbohovin
2/22/2019 - 2:10 PM
Git - правила написания коммитов https://habr.com/ru/company/yandex/blog/431432/
Git - правила написания коммитов https://habr.com/ru/company/yandex/blog/431432/
Git - правила написания коммитов
Разработчик должен придерживаться следующей структуры коммитов:
<type>(<scope>): <subject>
<body>
<footer>
- У коммита должен быть заголовок, может быть тело и нижний колонтитул.
- Заголовок коммита должен начинаться с типа (type), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием.
- Наряду с обязательными feat, fix (использование которых строго регламентировано), допускаются и другие типы.
- У коммита может быть область (scope). Она характеризует фрагмент кода, которую затронули изменения. Область следует за типом коммита. Стандарт не регламентирует четкий список областей. Примеры областей: eslint, git, analytics и т.д.
- Описание коммита должно быть сразу после типа/области.
- Тело коммита может быть использовано для детализации изменений. Тело должно быть отделено от описания пустой строкой.
- Нижний колонтитул следует использовать для указания внешних ссылок, контекста коммита или другой мета информации. Нижний колонтитул должен быть отделен от тела пустой строкой.
Кроме перечисленых в конвенции правил мы используем следущие популярные рекомендации:
- В теле коммита пишем что было изменено и почему.
- Используем следующие типы коммитов:
| Тип | Описание |
|---|---|
| Build | Сборка проекта или изменения внешних зависимостей |
| Сi | Настройка CI и работа со скриптами |
| Docs | Обновление документации |
| Feat | Добавление нового функционала |
| Fix | Исправление ошибок |
| Perf | Изменения направленные на улучшение производительности |
| Refactor | Правки кода без исправления ошибок или добавления новых функций |
| Revert | Откат на предыдущие коммиты |
| Style | Правки по кодстайлу (табы, отступы, точки, запятые и т.д.) |
| Test | Добавление тестов |
- Пишем описание в повелительном наклонении (imperative mood), точно также как сам Git.
Merge branch 'fix/SECRETMRKT-749-fix-typos-in-titles'
Style: Remove unused lines
- Не закачиваем описание коммита знаками препинания.