День 2210. #ЗаметкиНаПолях
Conventional Commits
Conventional Commits — это соглашение о сообщениях коммитов, которое предоставляет простой набор правил для создания явной истории коммитов.

Зачем?
- Автоматическое создание CHANGELOG.
- Автоматическое определение обновления версии на основе типов полученных коммитов.
- Сообщение сути изменений членам команды, общественности и другим заинтересованным лицам.
- Запуск процессов сборки и публикации.
- Упрощение участия людей в ваших проектах за счёт предоставления им возможности изучать более структурированную историю коммитов.

Согласно стандарту, сообщение о коммите должно быть структурировано следующим образом:

<тип>[необязательно, область]: <описание>

[необязательно, тело]

[необязательно, нижний колонтитул]

Сообщение содержит следующие структурные элементы, чтобы сообщать о намерении:
- тип fix – исправление ошибки в кодовой базе;
- тип feat - новая функция;
- другие типы: build, chore, ci, docs, style, refactor, perf, test и т.п.
- BREAKING CHANGE в нижнем колонтитуле, либо ! после типа коммита – ломающее изменение (может быть частью коммитов любого типа).
- Область действия может быть добавлена к типу коммита для предоставления дополнительной контекстной информации и заключена в скобки.

Примеры
Коммит без описания

docs: исправлены орфографические ошибки

Коммит с областью действия

feat(lang): добавлен перевод на английский

Коммит с ! (ломающее изменение) и областью действия:

feat(api)!: отправка email клиенту о доставке продукта

Коммит с телом и несколькими нижними колонтитулами:

fix: предотвратили гонку запросов

Добавлен идентификатор запроса и ссылка на последний запрос. Система отклоняет входящие ответы, отличные от последнего запроса.

Reviewed-by: ABC
Refs: #123

Спецификация
1) Коммиты должны иметь префикс типа (существительное), за которым следуют необязательные область действия и ! и обязательные двоеточие, пробел и описание.
2) Область действия может быть указана после типа. Она должна состоять из существительного в скобках, описывающего раздел кодовой базы.
3) Описание должно следовать сразу за двоеточием и пробелом после типа(области). Это краткое изложение изменений.
4) Более длинное тело коммита (дополнительная контекстная информация об изменениях кода) может быть указано ниже. Тело должно быть отделено пустой строкой.
5) Тело коммита имеет свободную форму и может состоять из любого количества абзацев, разделённых пустой строкой.
6) Один или несколько нижних колонтитулов могут быть добавлены после тела и пустой строки. Каждый должен состоять из токена слова, за которым следуют разделитель ": " или " #" и строковое значение.
- токен должен использовать дефис вместо пробелов (помогает отличить нижний колонтитула от тела). Исключение - BREAKING CHANGE;
- значение может содержать пробелы и символы новой строки.
7) Критические изменения должны быть указаны:
- в префиксе типа с помощью ! непосредственно перед двоеточием;
- в виде записи в нижнем колонтитуле с помощью текста "BREAKING CHANGE: " и описания.

Источник: https://www.conventionalcommits.org/en/v1.0.0/