Вы находитесь на странице: 1из 1

Как писать сообщения для коммитов

Команда, которая позволяет оставить сооб- Общие правила написания сообщений


щение для коммита: для коммитов:
• лаконично,
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 "If applied, this commit will
fix the bug in the function 'set'" fix the bug"

Пишите осмысленные сообщения


При написании сообщений для коммитов можно пользоваться формулой:
«Что сделать + для какой сущности + подробности (необязательно)».

# Хорошо. # Плохо.
"Fix a crashed function 'read file'" "Fix this"
"Add function 'get_positive'" "Add func"
"Add classes, group new fields" "Change classes"

Больше о коммитах и сообщениях для коммитов узнавайте из документации.

Вам также может понравиться