git commit - формат?

Question

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

Answer 1

Это зависит, конечно, но очень распространенный формат что-то вроде этого (взятую из 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 

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

Edit: Вот еще хорошее резюме, с этого сайта даже: In git, what are some good conventions to format multiple comments to a single commit

Answer 2

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

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