Сообщение о фиксации репозитория этикет

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

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

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

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

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

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

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

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

Fixed email bug

Как можно подробнее - всегда лучшая идея.

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

т.е. ОБЪЕДИНЕНИЕ: [из местоположения] [Начальный номер репозитория]: [Конечный номер репозитория] - [дополнительные комментарии]