Tutorials

Die perfekte Commit-Message schreiben

Betreff und Body, Imperativ, das Warum statt des Offensichtlichen. Ein evergreen Ratgeber für Commit-Messages, die auch in sechs Monaten noch helfen.

Die perfekte Commit-Message schreiben

Warum die Commit-Message so wichtig ist

Code sagt, was passiert. Die Commit-Message sagt, warum. Sechs Monate später erinnert sich niemand mehr an den Grund für eine Änderung, und genau dann rettet eine gute Nachricht Stunden. Eine Commit-Message ist kein lästiges Pflichtfeld, sondern eine Notiz an Dein zukünftiges Team und an Dich selbst.

Der Aufbau: Betreff und Body

Eine gute Commit-Message hat zwei Teile. Die erste Zeile ist der Betreff (Subject), eine knappe Zusammenfassung. Danach folgt, durch eine Leerzeile getrennt, der optionale Body mit den Details. Viele Werkzeuge und Oberflächen zeigen nur den Betreff, deshalb muss er für sich allein verständlich sein.

Regeln für den Betreff

  • Halte ihn kurz, als Faustregel unter etwa fünfzig Zeichen.
  • Schreib im Imperativ, also "Behebe Absturz beim Login" statt "Absturz behoben". So passt der Betreff zu dem, was Git selbst formuliert.
  • Kein Punkt am Ende, es ist eine Überschrift, kein Satz.
  • Sag, was der Commit tut, nicht wie er es tut. Das Wie steht im Code.

Wann Du einen Body brauchst

Bei einer trivialen Änderung reicht der Betreff. Sobald eine Entscheidung dahintersteckt, gehört sie in den Body. Erklär, warum die Änderung nötig war, welche Alternativen Du verworfen hast und was jemand wissen muss, der den Commit später liest. Nicht das Offensichtliche wiederholen, sondern den Kontext liefern, der im Code nicht steht.

Ein gutes Beispiel

Begrenze Upload-Größe auf zehn Megabyte

Große Uploads ließen den Worker volllaufen und
blockierten andere Anfragen. Das Limit deckt alle
realen Fälle ab und schützt den Dienst.

Konventionen im Team

In vielen Projekten hat sich ein festes Format eingebürgert, etwa ein Präfix wie feat, fix oder docs vor dem Betreff. Solche Conventional Commits helfen, die Historie maschinell auszuwerten und Changelogs zu erzeugen. Ob Du das nutzt, hängt vom Team ab. Wichtig ist vor allem Konsistenz. Ein Projekt, in dem alle Nachrichten demselben Muster folgen, liest sich viel leichter.

Wie Spire dabei hilft

Spire zeigt Betreff und Body getrennt an, damit die erste Zeile knapp bleibt und die Details Platz haben. Weil Du in Spire einzelne Zeilen stagen kannst, fällt es leichter, kleine, fokussierte Commits zu bauen, und fokussierte Commits lassen sich viel klarer beschreiben. Eine gute Nachricht beginnt nämlich schon bei einem Commit, der nur eine Sache tut.

Kurze Merkliste

  • Betreff kurz, im Imperativ, ohne Punkt.
  • Body erklärt das Warum, nicht das Offensichtliche.
  • Ein Commit, eine Sache.
  • Im Team einem einheitlichen Format folgen.

Teste Spire an deinen eigenen Repositories.

30 Tage kostenlos, kein Account, keine Kreditkarte. Der native Git-Client, der dir gehört statt gemietet zu sein.