git commit - Format?

Question

Was ist das empfohlene Format für die Commit-Nachrichten von git (COMMIT_EDITMSG), falls vorhanden?

Answer 1

Es variiert natürlich, aber ein sehr gängiges Format ist so etwas wie diese (von http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html genommen, dass ich denke, bringt es wirklich gut auf):

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 

Eine Sache, es geht nicht auf etwas Ich habe mich für mich selbst entschieden, nämlich mit kurzen Tags am Anfang der ersten Zeile, um zu identifizieren, welche Art von Commit es ist. Das könnten Tags wie [fix] für einen Bugfix, [new] für ein neues Feature oder [dev] für ein Commit sein, das nur Interna betrifft. Mit einer solchen Policy ist es einfach, ein Changelog automatisch aus den Commits zu generieren.

Edit: Hier ist eine andere gute Zusammenfassung, von dieser Seite auch: In git, what are some good conventions to format multiple comments to a single commit

Answer 2

ich nicht große Nachrichten empfehlen würde. Wenn Sie nicht in einem Satz erklären können, was Sie tun, umfasst Ihr Commit zu viel Veränderung. Verwenden Sie git rebase -i und teilen Sie Ihre Festschreibung auf, wenn Sie bereits festgeschrieben haben. Wenn Sie die Änderungen noch nicht übernommen haben, verwenden Sie git add -p, um in kleinen Teilen zu staffeln und dann als kleinere Commits zu committen.

Ein granularer Änderungsverlauf wie dieser hilft bei späteren Zusammenführungen und Rückständen. Es wird Ihnen auch helfen, sich mit Ihrem Issue Tracker zu verbinden. Wenn Sie zwei oder mehr Tickets adressiert haben, wird es schwieriger zu entschlüsseln, welches Ticket bei jeder Änderung des Commits adressiert wurde.