Формат комментариев в VCS — различия между версиями

Текущая версия на 14:15, 25 июля 2022

Комметарии должны быть в формате стандарт Conventional Commits, с нашими особенностями (тип коммита указываем в квадратных скобках)

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

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

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

Пример:

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

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

#redmine-11230
#jira-1234

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

• В заголовке сначала следует указывать модуль, для которого произошли изменения
• Использовать глаголы совершенного вида (Что сделано?)
• ссылку на redmine писать как #redmine-<номер задачи>
• ссылку на jira писать как #jira-<номер задачи>
• Стандарт допускает следующие типы коммитов:
  • build Сборка проекта или изменения внешних зависимостей
  • ci Настройка CI и работа со скриптами
  • docs Обновление документации
  • feat Добавление нового функционала
  • fix Исправление ошибок
  • perf Изменения направленные на улучшение производительности
  • refactor Правки кода без исправления ошибок или добавления новых функций
  • revert Откат на предыдущие коммиты
  • style Правки по кодстайлу (табы, отступы, точки, запятые и т.д.)
  • test Добавление тестов

Дополнительные правила принятые компании

• если доработка делается не в рамках какой-то задачи, то указывать по чьей просьбе сделаны изменения.
• если программист делает изменения по согласованию с 3 стороной (хост, комтек, личное общение с МО), то указывать ФИО программиста.

Ссылки

• https://www.conventionalcommits.org/ru/
• https://habr.com/company/yandex/blog/431432/