Основные правила написания комментариев к коммитам
Комментарий должен четко описывать, что было изменено и почему.
Использовать императивное наклонение
Начинать комментарий с глагола в повелительном наклонении, например: Add, Fix, Update. Объяснить причину внесения изменений, а просто перечислить, что изменилось.
Если изменения не очевидны, добавить объяснение того, почему они были сделаны.
Структура комментария
Первая строка должна быть кратким резюме изменений (50-72 символа). После пустой строки добавить более детальное описание, если необходимо.
Делать ссылки на задачи или тикеты
Упоминать идентификаторы задач или тикетов, если изменения связаны с определенной задачей.
Примеры комментариев к коммитам на английском
“Add user authentication feature”
“Fix bug in data processing module”
“Update dependencies to latest versions”
“Refactor code for improved readability”
“Remove deprecated API endpoints”
“Optimize image loading performance”
“Implement logging for error tracking”
“Add unit tests for validation functions”
“Improve UI responsiveness on mobile”
“Correct typo in documentation”
Основные правила написания комментариев к мерж-реквестам
Описывать цель изменений
Объяснить, что решает или улучшает данный мерж-реквест.
Указывать контекст
Предоставьте необходимый контекст для понимания изменений, особенно если они сложные.
Список изменений
Укажите основные изменения или нововведения, которые были сделаны.
Упомянуть связанные задачи
Указать, какие задачи или тикеты закрываются этим мерж-реквестом.
Запросить обратную связь
Запросить обратную связь у коллег, если это необходимо.
Примеры комментариев к мерж-реквестам на английском
“Implement new dashboard interface for better user experience”
“Fix issue #123 related to file upload failures”
“Add support for multiple languages in the application”
“Refactor authentication logic to improve security”
“Update README with setup instructions for new developers”
“Improve performance of data aggregation queries”
“Add logging and monitoring for critical services”
“Implement feature toggle for experimental features”
“Update CI/CD pipeline for automated testing”
“Resolve merge conflicts and align with latest main branch”