Как писать commit-сообщения на английском
Commit-сообщение объясняет, что и зачем изменилось в коде. Короткое и точное сообщение экономит время всей команде. Важно придерживаться единого стиля и всегда писать первую строку в повелительном наклонении.
Практические советы
1. Пишите в императиве
Add login page, Fix typo, Remove old file — так принято в большинстве проектов.
2. Держите первую строку короткой
До пятидесяти символов, чтобы она легко читалась в общем списке.
3. Объясняйте причину
В теле коммита обязательно напишите, зачем нужно это изменение.
4. Ссылайтесь на задачу
Номер тикета в сообщении связывает коммит с нужным рабочим контекстом.
5. Один коммит — одно изменение
Смешанные коммиты потом очень трудно проверять и безопасно откатывать.
Примеры с переводом
| English | Перевод |
|---|---|
| Add password reset form. | Добавить форму сброса пароля. |
| Fix crash on empty input. | Исправить падение при пустом вводе. |
| Update dependencies to the latest version. | Обновить зависимости до последней версии. |
Частые вопросы
На каком языке писать?
На английском, если проект международный, — это стандарт.
Нужны ли точки в конце?
Обычно нет: короткая строка без точки читается чище.
Что писать в теле?
Причину изменения и важные детали, если первая строка не всё объясняет.