СОГЛАШЕНИЕ О КОММИТАХ

Это соглашение помогает упростить ведение истории изменений, автоматизировать анализ изменений в коде и в целом повышает прозрачность для всей команды.

Основной формат сообщения коммита

В общем случае коммит имеет следующую структуру:

[type][optional область]: [краткое описание]

[optional "тело" коммита]

[optional "подвал"]

Текст коммита отвечает на вопросы:

• Что делал?
• Зачем?
• Другая дополнительная информация (например, о связи с issue)

Например:

fix(project1): added ru docs

see the issue for details

fixed issue #12

Типы коммитов

• fix: коммит, который исправляет "баги" в коде (PATCH в семантическом версионировании);
• feat: коммит, который добавляет функциональность в код (MINOR в semver);
• BREAKING CHANGE: несет в себе описание нарушений обратной совместимости с API (MAJOR в semver).
  Может относиться к коммиту любого типа. В этом случае BREAKING CHANGE: пишется в начале тела коммита или подвала, а после типа коммита ставится восклицательный знак (feat!:);

Дополнительные типы коммитов не требуются, но разрешены:

• docs: изменения в документации (README, комментарии к коду и т.п.);
• style: правки, не затрагивающие логику (форматирование, пробелы, запятые и т.д.);
• refactor: рефакторинг кода (изменения в коде без изменения ошибок или добавления "фичи");
• perf: изменения, связанные с производительностью;
• test: добавление или исправление тестов без изменений в рабочем коде;
• build: изменения в сборке проекта или внешних зависимостях;
• и другие.

Область коммита

После типа коммита через круглые скобки можно указать область затронутого кода, например:

Это помогает понять, что именно изменилось и в каком разделе проекта. Не является обязательным элементом.

Краткое описание

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

Тело коммита

Необязательный блок, в котором можно описать, зачем был сделан коммит, детали реализации и возможные "подводные камни".

Подвал коммита

Также необязательный блок. В нем указывают ссылки на задачи и "тикеты", к которым относится коммит.