При формировании сообщений коммитов придерживайтесь следующих принципов:
1. Императивный стиль, настоящее время
Используйте глагол в повелительном (императивном) наклонении в настоящем времени:
✔️ Правильно:
Add build script for project
❌ Неправильно:
I added build script for project
Added build script for project
2. Краткость и ясность
- Заголовок не длиннее 50 символов.
- Без лишних «I», «we», «the» и объяснений «почему» или «кто» (это можно вынести в тело коммита).
3. Структурированный формат (Conventional Commits)
При желании можно добавить тип изменения и область (scope) в соответствии с Conventional Commits:
<type>(<scope>): <subject>
- type —
feat,fix,docs,chore,refactorи т.д. - scope — модуль или компонент (необязательно).
- subject — краткое описание.
Пример:
feat(build): add build script
4. При необходимости — тело коммита
Если нужно пояснить «почему» или «как», добавьте тело коммита после пустой строки:
Add build script for project
Script uses webpack to bundle all source files
and outputs to /dist directory.
Примеры коротких и понятных сообщений
| Ситуация | Имя коммита |
|---|---|
| Добавили скрипт для сборки | Add build script for project |
| Исправили ошибку в модуле аутентификации | Fix authentication bug |
| Обновили документацию по установке | Update installation guide |
| Удалили устаревший CSS-файл | Remove deprecated CSS file |
| Рефакторинг компонента формы | Refactor form component |
Итог
- Используйте императив, настоящее время:
Add,Fix,Update… - Держите заголовок ≤50 символов, без лишних слов.
- При желании применяйте формат Conventional Commits:
feat(auth): add login endpoint - Расширяйте деталями тело коммита, если необходимо.