Порядок именования коммитов в git
вырабатываем приемлемый стандарт текстов для коммитов
Итак, попробуем в одной маленькой заметке определить стандарты текстов для коммитов в git, приемлемые и понятные для разработчиков.
Предлагаем привести коммиты к общему синтаксису следующего вида:
():
type
type должен обязательно иметь одно из значений, приведенных ниже:
-
build
: изменения, связанные со сборкой проекта (например, работа с библиотеками npm) -
chore
: изменения кода, которые не увидит внешний пользователь (например: изменения .gitignore файла), -
feat
: новые функции, -
fix
: исправление ошибок, -
refactor
: код, который не относится к добавлению новых функций или исправлению ошибок (например: изменение имен переменных), -
perf
: код, который улучшает производительность, -
style
: код, определяющий стили, -
test
: создание новых тестов или изменение существующих.
scope
Область видимости (scope) должна быть существительным и представлять наименование раздела или подраздела проекта.
subject
- глагол в повелительном наклонении (“add”, но не “adds” или “added”),
- нельзя использовать точки (.) в конце,
- нельзя использовать первую заглавную букву.
Спасибо за внимание.