Коммит‑мессаджи: правила написания

Коммит-мессаджи [1/2]

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

Все это, возможно, действительно имеет смысл в английском. Но на русском выглядит супер кринжово: «Покрась кнопку в красный цвет», «Отрефактори стор авторизации». С кем ты разговариваешь, бро? Ты же сам это только что сделал!

Если мы пишем русскоязычный проект в русскоязычной команде, то и коммиты следует подписывать на русском языке. Дальше обсуждаем только этот случай.

Коммит-мессаджи — это подписи, привязанные к изменениям в коде, которые сделал разработчик. Они могут быть полезными, а могут и не быть. И это зависит от их содержания. Круто бы научиться делать его полезным.

Давайте сначала рассмотрим кто и когда использует подписи коммитов: Сам разработчик, когда готовится к дейлику. Можно выписывать заметки себе на листочик, а можно в IDE сделать фильтр по имени и увидеть все что сделал вчера. Разрабочик, когда работает над задачей и изучает уже написанный код. Сейчас все IDE позволяют увидеть подписи коммита к каждой строчке кодовой базы. Тимлид, разбирающий баг на проде, чтобы выяснить почему так получилось, кто поставил такую задачу, и точно ли это баг, а не фича.

Собственно, чтобы коммиты были полезны, они должны содержать полезную для описанных выше случаев информацию, а бесполезную не содержать (с) Кэп Очевидность

Конкретные примеры в следующем посте

Подпишись на блог!