Как оформлять коммиты в гите


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

Сразу поделюсь хорошим материалом на medium.

Статья будет полезна кандидатам на наши открытые вакансии при решении тестовых заданий, новым сотрудникам и подрядчикам. Необязательно коммиты именно так, как я опишу ниже, но это заметно упростит процесс взаимодействия. Другим начинающим командам могу посоветовать придерживаться этих простых правил, а в устоявшихся командах в любом случае уже есть свои правила.

Если вы поленились прочитать статью medium, то настоятельно рекомендую это сделать сейчас. После прочтения мне не придется объяснить почему хороший коммит это важно.

Общая структура заголовка коммита выглядит так: <type>: <subject>, где <type> – тип коммита, должен быть один из следующих:

  • Feat: добавление нового функционала
  • Fix: исправление какой-либо программной ошибки
  • Docs: изменения в документации
  • Style: изменения в коде, не затрагивающие его содержание (форматирование, добавление точек с запятой и т.д.)
  • Refactor: изменения в коде, не исправляющие ошибок и не добавляющие новый функционал
  • Perf: изменения в коде, улучшающие произодительность
  • Test: добавление новых тестов или исправление существующих
  • Chore: любые другие изменения, не затрагивающие код
<subject> – суть коммита, например, add role to user class