In diesem Artikel beschreibt Chris Beams wie man eine gute Git-Commit-Nachricht formuliert: How to Write a Git Commit Message.
Er stellt dafür sieben Regeln auf:
- Subject und Body mit einer Leerzeile trennen.
- Subject auf 50 Zeichen beschränken.
- Subject mit einem Großbuchstaben beginnen.
- Subject nicht mit einem Punkt beenden.
- Im Subject den Imperativ benutzen.
- Den Body bei 72 Zeichen umbrechen.
- Erklären was und warum geändert wurde und nicht wie.
Seit Markus mir den Artikel geschickt hat, versuche ich selbst, mich an die Empfehlung des Autors zu halten. Und ich denke, die Vorgabe ist gerade für junge Entwickler sehr hilfreich. Oftmals sehe ich nämlich Nachrichten im Log wie
Verschiedene Änderungen am Programm
oder
Refactoring
Besonders bitter ist es, wenn die letzten Commits alle dieselbe Nachricht enthalten. Da wusste der Programmierer wohl selbst nicht, was er eigentlich gemacht hat.
Das geht so lange gut, wie man die Historie nicht benötigt, um eine gewisse Änderung nachzuvollziehen. Dann wir es nämlich sehr schwer, die betreffenden Commits zu identifizieren.
Also meine klare Empfehlung an jeden Azubi: Gewöhn dir gleich an, sprechende und hilfreiche Commit-Messages zu formulieren, die beschreiben, warum etwas geändert wurde und nicht wie (denn dafür ist die Software da).
Wie formulierst du die Commit-Nachrichten in deinem Versionsverwaltungssystem? Gibt es Regeln, an die du dich hältst?