Формат комментариев в VCS

Материал из ИбисоПедии
Перейти к: навигация, поиск

Комметарии должны быть в формате стандарт Conventional Commits, с нашими особенностями

[<тип коммита>]: <Заголовок>

<Детализация коммита - отделена пустой строкой>

<Нижний колонтитул следует использовать для указания внешних ссылок, контекста коммита или другой мета информации. Нижний колонтитул должен быть отделен от тела пустой строкой>

Пример:

[fix]: Аналитика. Источник данных "Люди". Исправлено поведение поля "Пол" 

Поле "Пол" неправильно показывалась для пациентов старше 60-ти лет

redmine-11230


Общие положения

  • В заголовке сначала следует указывать модуль, для которого произошли изменения
  • Использовать глаголы совершенного вида (Что сделано?)
  • ссылку на redmine писать как redmine-<номер задачи>

Ссылки