git commit - форматировать? - PullRequest
9 голосов
/ 08 ноября 2010

Какой формат рекомендуется использовать в сообщениях коммитов git (COMMIT_EDITMSG), если они есть?

Ответы [ 2 ]

13 голосов
/ 08 ноября 2010

Конечно, это варьируется, но очень распространенным форматом является что-то вроде этого (взято из http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html,, который, я думаю, действительно хорошо суммирует):

Short (50 chars or less) summary of changes

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded by a
   single space, with blank lines in between, but conventions vary here

Одна вещь, к которой она не относится, - это то, что я принял для себя, а именно использование коротких тегов в начале первой строки, чтобы определить, что это за коммит. Это могут быть теги типа [fix] для исправления ошибки, [new] для новой функции или [dev] для коммита, который влияет только на внутренние компоненты. При такой политике легко генерировать журнал изменений из коммитов.

Редактировать: Вот еще одна хорошая сводка, даже с этого сайта: В git, какие есть хорошие соглашения для форматирования нескольких комментариев в один коммит

1 голос
/ 09 ноября 2010

Я бы не рекомендовал большие сообщения. Если вы не можете объяснить в одном предложении, что вы делаете, ваш коммит содержит слишком много изменений. Используйте git rebase -i и разделите ваш коммит, если вы уже зафиксировали. Если вы еще не зафиксировали изменения, используйте git add -p для поэтапной обработки небольшими частями, а затем фиксируйте как меньшие коммиты.

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...