Как писать сообщения для коммитов
Команда, которая позволяет оставить сообщение для коммита:
git commit -m
Общие правила написания сообщений
для коммитов:
• лаконично,
• однородно,
• осознанно.
Старайтесь писать комментарии по-английски — это считается хорошим тоном. Но Git
понимает кириллицу, и писать комментарии на русском можно, например, в том случае,
если вы на 100% уверены, что ваш код будет интересен только русскоязычной аудитории.
Пишите сообщения с заглавной буквы
# Хорошо.
"Add 'get' method to post model"
# Плохо.
"add 'get' method to post model"
Не используйте прошедшее время
# Хорошо.
"Fix the bug in the function 'set'"
# Плохо.
"Fixed bug in the function 'set'"
Чтобы составлять сообщения в нужном формате было проще, воспользуйтесь одним из лайфхаков:
1. Представьте, что вы обращаетесь к Git: «Git, добавь», «Git, удали».
2. Подставьте строку сообщения во фразу If applied, this commit will … :
If applied, this commit will <сообщение для коммита>.
По возможности указывайте на исходный код в сообщении
# Хорошо.
"If applied, this commit will
fix the bug in the function 'set'"
# Плохо.
"If applied, this commit will
fix the bug"
Пишите осмысленные сообщения
При написании сообщений для коммитов можно пользоваться формулой:
«Что сделать + для какой сущности + подробности (необязательно)».
# Хорошо.
"Fix a crashed function 'read file'"
"Add function 'get_positive'"
"Add classes, group new fields"
# Плохо.
"Fix this"
"Add func"
"Change classes"
Больше о коммитах и сообщениях для коммитов узнавайте из документации.