Перейти к основному содержимому

Правила Сообщений Коммитов

Назначение​

Документ фиксирует, как писать тексты сообщений git-коммитов в Pin. Дополняет docs/08-devops/git-workflow.md (ветки, atomic-commits, запрещённые действия) в части текста сообщения.

Язык И Стиль​

  • Сообщение коммита пишется на русском языке.
  • Английский допустим только для технических идентификаторов: имена классов/методов, API-пути, имена enum/событий, названия пакетов и технологий.
  • Текст должен быть осмысленным, человекочитаемым и понятным — что и зачем изменено по сути.

Без Мусора​

  • Не добавляй в сообщение служебный шум о процессе проверки: «проверено», «подтверждено на живом API», «тесты зелёные», «сборка зелёная», «tsc -b и vite build зелёные», «отлажено в preview» и т.п.
  • Это избыточно: сломанный код мы не коммитим по умолчанию, поэтому отдельно сообщать, что он «работает», не нужно. Сообщение описывает изменение, а не отчёт о прогоне проверок.

Примеры​

Плохо (мусор о проверках, детали процесса):

fix(schema): починил редактор

Подтверждено на живом API (:5100): схема создаётся.
tsc -b --noEmit --force и vite build зелёные; редактор проверен в preview
(RU-лейблы типа, переключение валидации текст<->число, контраст карточек).

Хорошо (суть по-человечески):

Редактор схемы каталога: порядок полей стрелками вместо числового Order,
«Обязательное» перенесено в раздел валидации

Формат​

  • Допускается conventional-commit-префикс, когда уместно (feat/fix/docs/refactor/chore/test
    • scope), но summary — на русском и по сути изменения.
  • Один коммит — один завершённый осмысленный шаг; не смешивай несвязанные изменения; держи документацию и реализацию одного поведения в одном коммите.
  • Запрещённые git-действия и работа с ветками — см. git-workflow.md.

Обратные ссылки​

Автоссылки: где используется этот документ.