Репозиторий Commit Msg Этикет

Question

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

Например, может быть добавить тег (ы), такие как: исправление ошибок, обновление, внедрение?Просто интересно, как профессионалы описывают свои коммиты.

Надеюсь, это поможет мне организовать проект ...

Answer 1

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

Суть в том, что сообщение должно иметь смысл для a) других людей, чтобы они понимали, что было сделано, не глядя на код, и b) для себя, когда через год вы просматриваете журнал, пытаясь найти вы исправили ошибку в foobar.

Пример хорошего сообщения:

Fixed the bug where the program would crash if the number of entries was zero
(issue #2857)

Пример плохого сообщения:

Fixed email bug

Answer 2

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

Answer 3

Как можно более многословно, это всегда лучшая идея.

Также обязательно прокомментируйте ветки, теги и слияния правильно. Это избавит вас от головной боли.

т.е. MERGE: [from location] [Start repo #] : [end repo #] - [additional comments]

Answer 4

Существуют очень разные подходы к этому, некоторые люди даже не используют сообщения коммитов, а фиксируют файл ChangeLog вместе с остальными (хотя я бы не рекомендовал это делать, так как объединяться постоянно). Я полностью согласен с Майклом, просто хотел отметить, что разные среды более или менее полезны, когда речь идет о фиксации сообщений, например, git имеет определенное предпочтение , как должны выглядеть сообщения.

Если вы используете, например, trac , это поможет вам ввести туда номер билета с определенным синтаксисом (например, # 1234, по крайней мере, я так думаю), что приведет к он отображается как гиперссылка при просмотре на временной шкале trac.