Wie sieht eine gute Commit-Message in Git aus?
Mit dem Artikel „How to Write a Git Commit Message“ habe ich meinen persönlichen Stil für eine gute Git-Commit-Message weiter verfeinert. Für mich sieht eine gute Commit-Message nun wie folgt aus:
Kurz-Zusammenfassung (max. 50 Zeichen), als Aufforderung geschrieben, ohne Punkt am Ende
Optional: Erweiterte Markdown-Beschreibung, abgetrennt durch eine Leerzeile.
Der Text der gesamten Commit-Message ist dabei in Englisch.
Und wenn ihr ein Ticket-System verwendet, solltet ihr die Ticket-Nummer in die Commit-Message mit aufnehmen:
Kurz-Zusammenfassung (max. 50 Zeichen), als Aufforderung geschrieben, refs TICKET-NUMMER
Optional: Erweiterte Markdown-Beschreibung, abgetrennt durch eine Leerzeile.
Der Text der gesamten Commit-Message ist dabei in Englisch.
Jüngstes Beispiel vom Blogophon:
Add CSS variable `--gallery-count` to gallery HTML
Check https://css-tricks.com/simple-swipe-with-vanilla-javascript/ on what to do with that.
Aber ehrlich gesagt ist der Artikel „How to Write a Git Commit Message“ die bisher beste und umfassendste Antwort auf die Frage nach einer guten Commit-Message.
