Осмысленные коммиты
Коммит должен начинаться с типа (type), указывающего на специфику внесенных в кодовую базу изменений, и завершаться описанием.
У коммита может быть область (scope). Она характеризует фрагмент кода, которую затронули изменения. Область следует за типом коммита.
Примеры
Заголовок раздела «Примеры»feat: send an email to the customer when a product is shipped
fix(products): поправить длину строки с ценой
Таблица типов
Заголовок раздела «Таблица типов»тип | описание |
---|---|
fix | Исправление ошибок |
feat | Добавление нового функционала |
style | Правки по кодстайлу (табы, отступы, точки, запятые и т.д.) |
refactor | Правки кода без исправления ошибок или добавления новых функций |
perf | Изменения направленные на улучшение производительности |
build | Сборка проекта или изменения внешних зависимостей |
ci | Настройка CI и работа со скриптами |
docs | Обновление документации |
revert | Откат на предыдущие коммиты |
test | Добавление тестов |