2.6 KiB
2.6 KiB
title | localeTitle |
---|---|
Writing Good Git Commit Messages | Написание хороших сообщений Git Commit |
- Отдельный объект из тела с пустой строкой
- Ограничьте строку темы до 50 символов
- Заглавие строки темы
- Не завершайте строку темы с периодом
- Используйте императивное настроение в строке темы
- Оберните тело 72 символами
- Используйте тело, чтобы объяснить, что и почему против
Правильно сформированная строка темы git commit должна всегда иметь возможность выполнить следующее предложение:
Если это применимо, эта фиксация будет
<<your subject line here>>
Например:
- Если применяется, это фиксация будет подсистемой X Refactor для удобочитаемости
- Если применяется, эта фиксация обновит начальную документацию
- Если применяется, эта фиксация будет удалять устаревшие методы
- Если применяется, этот коммит будет выпущен версии 1.0.0
- Если применяется, эта фиксация будет объединять запрос на вывод № 123 от пользователя / ветки
Обратите внимание, что это не работает для других неимперативных форм:
- Если применяется, эта фиксация будет исправлена ошибка с Y
- Если применяется, это коммит будет изменять поведение X
- Если применяется, это фиксация будет больше исправления для сломанных вещей
- Если применить этот коммит, будут применены новые методы API
Помните: использование императива важно только в строке темы. Вы можете смягчить это ограничение, когда пишете тело.