Руководство по написанию кода

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

Сам формат опционален и может быть разным на разных проектах в зависимости от используемых технологий и требований, однако рекомендуется, чтобы каждый коммит содержал в себе:

• тип изменений, который содержит коммит;
• область кода, в которой производились изменения;
• сообщение;
• описание, как правило пишется через пустую строку от заголовка коммита. Может содержать более подробное описание изменений, важное замечание, ссылку на задачу, к которой коммит относится.

Допустимые значения типов могут меняться от проекта к проекту. Основными типами являются:

• feat - новый функционал;
• fix - исправление ошибок;
• docs - изменения в документации;
• style - форматирование кода и правки кодстайла;
• refactor - изменения в коде, которые не влияют на поведение;
• test - изменения в тестах;
• ci - изменения в CI/CD;
• perf - оптимизации скорости работы;

Если задача существует в JIRA, то коммит следуем именовать следующим образом – [номер задачи и проект из JIRA]: [название задачи]. Это позволит JIRA автоматически связать merge request с задачей.