dr.Brain

doctor Brain

мир глазами веб-разработчика

Порядок именования коммитов в git

вырабатываем приемлемый стандарт текстов для коммитов

dr.Brain

время чтения 1 мин.

Photo by Ray Hennessy on Unsplash

Итак, попробуем в одной маленькой заметке определить стандарты текстов для коммитов в git, приемлемые и понятные для разработчиков.

Предлагаем привести коммиты к общему синтаксису следующего вида:

<type>(<scope>): <subject>

type

type должен обязательно иметь одно из значений, приведенных ниже:

  1. build: изменения, связанные со сборкой проекта (например, работа с библиотеками npm)
  2. chore: изменения кода, которые не увидит внешний пользователь (например: изменения .gitignore файла),
  3. feat: новые функции,
  4. fix: исправление ошибок,
  5. refactor: код, который не относится к добавлению новых функций или исправлению ошибок (например: изменение имен переменных),
  6. perf: код, который улучшает производительность,
  7. style: код, определяющий стили,
  8. test: создание новых тестов или изменение существующих.

scope

Область видимости (scope) должна быть существительным и представлять наименование раздела или подраздела проекта.

subject

  1. глагол в повелительном наклонении (“add”, но не “adds” или “added”),
  2. нельзя использовать точки (.) в конце,
  3. нельзя использовать первую заглавную букву.

Спасибо за внимание.

Новые публикации

Далее

Категории

О нас

Frontend & Backend. Статьи, обзоры, заметки, код, уроки.