Правильные сообщения - PullRequest
6 голосов
/ 10 июня 2010

Для чего нужны сообщения о коммите? Я всегда писал их как объяснение того, что я сделал, но недавно я начал обсуждать это с коллегой, который пишет сообщения коммитов, объясняющие, почему он это сделал. Какой из них правильный, или есть другой ответ полностью?

ПРИМЕЧАНИЕ. Я понятия не имею, существует ли для этого «правильный» ответ. Таким образом, я назвал это сообщество вики и не приму ответ. Голосование должно определиться с победителем:)

Ответы [ 4 ]

6 голосов
/ 10 июня 2010

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

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

1 голос
/ 10 июня 2010

Сообщения коммитов - это то, что вы делаете из них, но когда их сотни для определенного файла или тысячи для проекта, вы хотите иметь возможность просматривать их в поисках определенных изменений или характера изменений. По сути, они похожи на комментарии к коду и должны быть максимально полезными, но в то же время лаконичными и содержательными. Возможно, лучше всего думать о них как о твиттах - передать максимальное значение за короткий промежуток времени.

Как человек, который работал над большими кодовыми базами, охватывающими десятилетия, а также небольшими проектами, охватывающими год или два, я не нашел ничего более раздражающего при комбинировании журналов фиксации, чем сообщения типа "упс" или "исправленная ошибка". Если вы исправили ошибку, сообщите нам, какая из них (по крайней мере, номер ошибки). Это все важно для судебной экспертизы в будущем.

1 голос
/ 10 июня 2010

Я использую сообщение о фиксации в качестве исполнительного резюме из что было изменено.

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

почему задокументировано где-то еще: система отслеживания проблем, документация по требованиям и т. Д. Я также включаю ссылки из сообщения о фиксации на почему и наоборот.

1 голос
/ 10 июня 2010

Я думаю, что оба полезны.Краткое описание того, что изменилось («Добавление проверки длины для AddUserForm») проще, чем просмотр diff, особенно если вы просматриваете несколько коммитов.Почему изменение было сделано, какая ошибка исправлена ​​и т. Д., Очевидно, тоже очень полезно иметь.

...