2.3 KiB
Raw Permalink Blame History

name description
git-commit-rus Правила оформления коммитов — conventional commits на русском языке

Git-коммиты: стиль ludmila

Все коммиты в проекте оформляются по правилам conventional commits на русском языке.

Формат

тип: описание на русском языке

Типы

Тип Когда использовать
feat: Новая функциональность
fix: Исправление бага
refactor: Переработка кода без изменения поведения
perf: Оптимизация производительности
test: Добавление или изменение тестов
chore: Сборка, CI, зависимости, ченжлоги, обновление версии
docs: Документация
style: Форматирование, отступы, точки с запятой (не CSS)

Правила

  • Описание на русском, в настоящем времени, повелительное наклонение
  • Без точки в конце
  • Без номера задачи в названии
  • Одно изменение — один коммит (squash перед коммитом)
  • Первая буква описания строчная (соответствует conventional commits)

Примеры

feat: добавил запись встреч и полнотекстовый поиск по транскриптам
fix: исправил z-index EmojiPicker в StatusPicker через portal
refactor: синхронизация тредов через sidebarStore напрямую без threadMuteSignal
perf: денормализовал last_reply_at и first_participant_ids, добавил треды в bootstrap
chore: обновил ченжлог 1.7.4
test: добавил тесты на guard wiki_enabled — tree, create, read, channel list/count

Процесс

Перед коммитом:

  1. git status — проверить, что staged только нужные файлы
  2. git diff --cached — проверить изменения
  3. Написать коммит по формату выше