Сообщение для коммита - короткое описание работы, проведенной с файлами проекта до фиксации очередных изменений.

Хорошие сообщения для коммитов не только облегчают работу в случае, когда несколько разработчиков вовлечены в один проект. Они так же важны и для индивидуальных проектов, потому что позволяют четко понимать - какие изменения сопровождали каждый конкретный коммит.

Рекомендую всем разработчикам установить для себя правило: даже работая над личным проектом, нужно писать хорошие сообщения для коммитов.

Ниже, я хочу предложить шаблон для сообщений, который использую практически для всех проектов (естественно, шаблон можно менять в зависимость от задач, решаемых в рамках проекта, особенностей организации рабочего проекта или Ваших предпочтений):

type: subject
body (optional)
footer (optional)

1. Type

• feat - новый функционал,
• fix - исправление ошибок,
• docs - изменения в документации,
• style - все, что связано со стилями,
• refactor - изменения кода, не связанные с разработкой нового функционала или исправлением ошибок,
• test - все, что связано с тестированием,
• chore - обновление задач, изменения в пакетных менеджерах или менеджерах зависимостей.

2. Subject

Короткое описание изменений.

требования к описанию:

• Не более 50 символов,
• на английском языке,
• начинается с большой буквы,
• в императивной форме (Add, а не Added или Adds).

3. Body

Более подробное описание изменений, возможно, с указанием причин, которые повлекли внесение этих изменений. Body является опциональной структурой, так как не все коммиты настолько сложны, чтобы сопровождаться подробными описаниями. Вряд ли Body потребуется для личного проекта.

4. Footer

Footer тоже является опциональной структурой и требуется только в том случае, когда вы используете различные трекеры, для указания идентификатора (ID) проблемы или задачи.

Спасибо за внимание.

Написано по материалам статьи Udacity Git Commit Message Style Guide.