Best Practices für Commit-Nachrichten

Stellen Sie sich vor, Sie blicken auf die Historie Ihres Projekts zurück. Ohne klare Commit-Nachrichten ist das, als würden Sie ein Tagebuch mit leeren Einträgen lesen!

Gute Commit-Nachrichten sind entscheidend, um zu verstehen, warum Änderungen vorgenommen wurden, was geändert wurde und wie sich die Änderungen auf das Projekt auswirken. Das hilft Ihnen und Ihrem Team beim Debuggen, beim Code-Review und beim Einarbeiten neuer Teammitglieder.

Eine standardmäßige Git-Commit-Nachricht besteht aus zwei Hauptteilen:

• Betreffzeile: Eine einzelne, prägnante Zeile, die die Änderung zusammenfasst.
• Text (optional): Eine ausführlichere Erklärung, die durch eine Leerzeile vom Betreff getrennt ist.

Stellen Sie sich die Nachricht wie eine E-Mail vor: eine Betreffzeile zum schnellen Überfliegen und einen Text für die Details.

Die Betreffzeile ist der wichtigste Teil. Beachten Sie dabei folgende Regeln:

• Prägnant: Beschränken Sie sie auf 50–72 Zeichen.
• Imperativ: Beginnen Sie mit einem Verb im Präsens, zum Beispiel „Add feature“ statt „Added feature“ oder „Adding feature“.
• Ersten Buchstaben großschreiben: Das ist für eine bessere Lesbarkeit üblich.
• Kein Punkt: Beenden Sie die Betreffzeile nicht mit einem Punkt.

Sehen wir uns einige gute und schlechte Betreffzeilen an:

• Gut: Fix: broken login button
• Gut: Feat: implement user profile page
• Schlecht: Fixed a bug in the login system that was causing issues. (Zu lang, Vergangenheit)
• Schlecht: updates (Zu vage)

Streben Sie nach Klarheit und Kürze!

Im Commit-Text erklären Sie die Motivation für die Änderung, den Kontext und alle Details, die aus dem Code selbst nicht ersichtlich sind.

Verwenden Sie ihn, wenn Ihre Änderung mehr Erklärung benötigt, als die Betreffzeile bieten kann. Begrenzen Sie die Zeilen für eine bessere Lesbarkeit in Git-Tools auf etwa 72 Zeichen.

Beachten Sie beim Schreiben des Textes:

• Erklären Sie, warum die Änderung vorgenommen wurde, nicht nur was geändert wurde.
• Beschreiben Sie Abwägungen oder Designentscheidungen.
• Weisen Sie auf mögliche Nebenwirkungen oder Bereiche hin, die beobachtet werden sollten.
• Lassen Sie eine Leerzeile zwischen Betreff und Text.

So erhalten zukünftige Leser wertvollen Kontext.

So könnte eine vollständige, gut strukturierte Commit-Nachricht aussehen:

Viele Teams verwenden eine Konvention, bei der die Betreffzeile mit einem Typpräfix beginnt. Dadurch lassen sich Änderungen schnell kategorisieren.

Häufige Präfixe sind:

• feat: (neue Funktion)
• fix: (Fehlerbehebung)
• docs: (Änderung an der Dokumentation)
• style: (Code-Stil, keine funktionale Änderung)
• refactor: (Umstrukturierung des Codes)
• test: (Hinzufügen von Tests)
• chore: (Wartung, Änderungen am Build-Prozess)

Es ist eine gute Vorgehensweise, Ihre Commits im Projektmanagementsystem mit zugehörigen Issues oder Pull Requests zu verknüpfen, etwa mit GitHub Issues oder Jira.

Fügen Sie dazu Formulierungen wie Closes #123, Fixes #45 oder Refs #67 in Ihre Commit-Nachricht ein, normalerweise in den Text. Dadurch werden Ihre Codeänderungen automatisch mit der erfassten Aufgabe verknüpft.

Welche der folgenden Eigenschaften hat eine gut geschriebene Git-Commit-Nachricht gemäß den Best Practices?

Sie haben gelernt, dass sorgfältig formulierte Commit-Nachrichten für Klarheit und Zusammenarbeit in Projekten entscheidend sind. Wenn Sie diese Best Practices befolgen, wird Ihre Projekthistorie zu einer wertvollen Ressource!

• Halten Sie Betreffzeilen prägnant und formulieren Sie sie im Imperativ.
• Verwenden Sie den Text, um zu erklären, „warum“ eine Änderung vorgenommen wurde.
• Erwägen Sie Typpräfixe zur Kategorisierung.
• Verknüpfen Sie Issues oder Pull Requests, um Kontext bereitzustellen.

Viel Erfolg beim Committen!