OTCloud
@OTCloud
- И как назовемся? Пожиратели пожирателей смерти?

Какой смысл писать комментарий к коммиту?

Перед тем как читать вопрос ознакомься с этой статьей или её переводом, чтобы понять о чем речь.

Недавно с коллегами перешли на трекер, для организации работы. Соответственно возник вопрос "как связать задачи в трекере с изменениями в репозитории? Как оформлять ветки и коммиты?"
По ходу обсуждения решили что есть смысл именовать ветки по коду задачи из трекера, например, PRJ-3 и аналогично коммиты PRJ-3. Возникло предложение писать коммиты в таком формате PRJ-3 <краткий коммент к коммиту>, но не увидели в комментах к коммиту смысла (коммент ради коммента).

Как вы считаете, когда есть смысл писать коммент к коммиту и есть ли он вообще?
  • Вопрос задан
  • 298 просмотров
Решения вопроса 2
DevMan
@DevMan Куратор тега Git
осмысленное описание комита - маст хэв.
prj-3 - это говно, а не описание комита.

на самом деле тут роялят много моментов. но описание комита должно быть информативным.как минимум финального, который пойдет в релизную ветку.
Ответ написан
iiiBird
@iiiBird
Пока ты спишь - твой конкурент совершенствуется
ну вот представь ситуацию, что ты свою задачу "PRJ-3" не смог с одного коммита сделать (а такое случается довольно часто). и вот у тебя образовалось 20 коммитов с комментом "PRJ-3". и ты там много чего переделывал и теперь опять что-то изменилось и тебе нужно посмотреть одну из первых реализаций задачи. ты помнишь, что она где-то в начальных коммитах, но не помнишь в каком. вот тебе и придется сидеть и открывать по одному эти коммиты и смотреть тот это или не тот.
а были бы комментарии нормальные - ты бы это увидел по ним и лишних движений бы не было.
p.s. а когда с момента реализации прошла неделя, месяц, год - ситуация усложняется в разы. потому что тут уже ты и сам не будешь помнить что и когда ты писал.
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы