So schreiben Sie eine effektive, nützliche Git-Commit-Nachricht

Commit-Nachrichten sind kurze Beschreibungen jedes Commits in einem Versionskontrollsystem wie Git. Wenn Sie Änderungen an Ihren Projektdateien vornehmen, sollten Sie eine Nachricht bereitstellen, in der erklärt wird, was sie bewirken oder warum Sie sie vorgenommen haben.

Commit-Nachrichten dienen der Dokumentation und Kommunikation. Sie spielen eine entscheidende Rolle bei der Aufrechterhaltung eines klaren und organisierten Versionsverlaufs eines Projekts. Erfahren Sie, wie Sie gute Commit-Nachrichten verfassen, und die anderen Mitglieder Ihres Teams werden Ihre Arbeit noch mehr zu schätzen wissen.

Struktur einer guten Commit-Nachricht

Ein gutes Beispiel für eine Commit-Nachricht besteht aus vier Abschnitten: Typ, Beschreibung, Text und Fußzeile.

Etwa so:

: 
[optionaler Text]
[optionale Fußzeile]

Typ

Der Typ beschreibt die Art der Änderung, die im aktuellen Commit vorgenommen wurde. Sie können jedes System verwenden, das für Ihre Umstände sinnvoll ist. Hier sind beispielsweise einige Beispielschlüsselwörter, die Sie verwenden können, um jede Art von Änderung zu signalisieren, sowie Beispiele für die Verwendung:

• feat: Ihre Änderungen führen eine neue Funktion ein.
• Fix: Sie beheben einen Fehler.
• Refaktor: Ihr Change-Refactoring-Code, ohne einen Fehler zu beheben oder eine neue Funktion hinzuzufügen.
• prüfen: Sie nehmen alle testbezogenen Änderungen vor. Zum Beispiel, wenn Sie Schreiben Sie Tests mit Jest oder irgendein Anderes Test-Framework du wählst.
• lästige Pflicht: Änderungen, die nichts mit einem Fix, einer Funktion oder einem Test zu tun haben. Beispielsweise das Aktualisieren von Abhängigkeiten.
• Dokumente: wenn Sie die Dokumentation aktualisieren.
• Stil: Änderungen, die sich nicht auf die Bedeutung des Codes auswirken, z. B. das Hinzufügen von Leerzeichen, fehlende Semikolons usw.
• perf: Änderungen im Zusammenhang mit Leistungsverbesserungen.
• bauen: Wenn Sie Änderungen vornehmen, die sich auf die Build-Dateien auswirken.
• ci: Änderungen im Zusammenhang mit der kontinuierlichen Integration.
• zurückkehren: beim Zurückkehren zu einem vorherigen Commit.

Beschreibung

Die „Beschreibung“ einer Commit-Nachricht ist eine prägnante und beschreibende Zusammenfassung der im Commit vorgenommenen Änderungen. Es dient als Überschrift, die das Wesentliche des Commits widerspiegelt.

Beachten Sie beim Verfassen der Beschreibung Folgendes:

• Machen Sie es klar und spezifisch genug, um den Commit auf einen Blick zu beschreiben.
• Machen Sie es kurz und prägnant. Idealerweise wäre es am besten, die Länge auf 50 Zeichen oder weniger zu beschränken.
• Schreiben Sie es im Präsens, auch wenn Sie bereits vorgenommene Änderungen beschreiben.
• Nutzen Sie beim Schreiben den zwingenden Ton.
• Beginnen Sie mit einem Großbuchstaben.
• Beenden Sie es nicht mit einem Punkt.

Zum Beispiel:

Kunststück: Implementieren Sie das Umschalten des Dunkelmodus für die Startseite

Dieses Beispiel zeigt, wie Sie die Beschreibung für einen Commit schreiben können implementiert den Dunkelmodus. Es nutzt die feat Typ, weil es eine neue Funktion einführt.

Körper (optional)

Der Textabschnitt einer Commit-Nachricht enthält zusätzliche Details und Kontext zu den im Commit vorgenommenen Änderungen. Sie benötigen nicht immer einen Körper, aber er kann dabei helfen, weitere Informationen bereitzustellen, die Gründe für eine Änderung zu erläutern oder technische Überlegungen zu beschreiben.

Beim Schreiben des Hauptteils einer Commit-Nachricht sind folgende Dinge zu beachten:

• Git bricht Text nie automatisch um, also brechen Sie ihn manuell mit 72 Zeichen um, wenn Sie den Text schreiben. Dies gibt Git genügend Platz, um Text einzurücken und ihn so besser lesbar zu machen.
• Benutzen Sie den Hauptteil, um zu erklären, was bei der Änderung passiert ist, warum Sie die Änderung vorgenommen haben und welche Gründe hinter Ihrer Änderung stecken.
• Sie müssen zwischen der Beschreibungszeile und dem Text eine Leerzeile lassen. Dadurch kann Git zwischen ihnen unterscheiden.
• Wenn der Commit mehrere Änderungen mit sich bringt oder verschiedene Bereiche der Codebasis betrifft, sollten Sie Aufzählungspunkte oder Absätze verwenden, um die Änderungen aufzuschlüsseln. Dies verbessert die Lesbarkeit und hilft den Lesern, die verschiedenen Aspekte des Commits zu verstehen.

Zum Beispiel:

Kunststück: GitHub als OAuth-Anbieter hinzufügen
Integrieren Sie GitHub als OAuth-Anbieter, um nahtlose Prozesse zu ermöglichen 
Authentifizierung mit GitHub-Konten.
– Implementieren Sie den OAuth-Authentifizierungsfluss mit der GitHub-API
– Konfigurieren Sie die erforderlichen Endpunkte und Einstellungen für die GitHub-Authentifizierung
– Aktualisieren Sie die Benutzeroberfläche, um die GitHub-Anmeldeoption einzuschließen

Das obige Beispiel zeigt eine gute Git-Commit-Nachricht für eine Funktion, die hinzufügt GitHub als OAuth-Anbieter zu Ihrer Bewerbung. Diese Commit-Nachricht enthält eine kurze Zusammenfassungszeile (maximal 50 Zeichen), einen ausführlicheren erläuternden Text (ca. 72 Zeichen lang) und Aufzählungspunkte für zusätzliche Informationen.

Der Fußzeilenabschnitt in einer Commit-Nachricht ist ein optionaler Teil, der zusätzliche Informationen oder Metadaten im Zusammenhang mit dem Commit bereitstellt. Es wird normalerweise nach dem Körperabschnitt platziert, getrennt durch eine Leerzeile. Die Fußzeile kann verschiedene Arten von Informationen enthalten, beispielsweise Verweise auf verwandte Themen, Tags oder besondere Hinweise.

Wenn Sie auf Issues, Pull Requests oder andere verwandte Elemente verweisen, verwenden Sie die entsprechende Syntax oder das entsprechende Format, das für das Issue-Tracking-System Ihres Projekts erforderlich ist. Dadurch wird sichergestellt, dass die Referenzen richtig erkannt und verknüpft werden.

Zum Beispiel:

feat: GitHub als OAuth-Anbieter hinzufügen
Integrieren Sie GitHub als OAuth-Anbieter, um nahtlose Prozesse zu ermöglichen 
Authentifizierung mit GitHub-Konten.
– Implementieren Sie den OAuth-Authentifizierungsfluss mit der GitHub-API
– Konfigurieren Sie die erforderlichen Endpunkte und Einstellungen für die GitHub-Authentifizierung
– Aktualisieren Sie die Benutzeroberfläche, um die GitHub-Anmeldeoption einzuschließen
Behebt: #123
Siehe auch: #456, #789

Die Fußzeile verweist auf das verwandte Problem Nr. 123 und erwähnt andere verwandte Probleme Nr. 456 und Nr. 789 für zusätzlichen Kontext.

Hinzufügen der Commit-Nachricht

Sie können Commit-Nachrichten mit schreiben -M Flag, gefolgt von der Commit-Nachricht in Anführungszeichen (optional, aber empfohlen).

Der -M Flag ist ideal für kurze Commit-Nachrichten, normalerweise einschließlich Typ und Beschreibung.

Zum Beispiel:

git commit -m „chore: Linter in ESlint ändern“

Wenn Ihre Commit-Nachricht jedoch detailliertere Informationen erfordert, beispielsweise einen Textkörper und eine Fußzeile, ist es besser, den Commit in einem Texteditor oder einer IDE zu schreiben.

Alternativ können Sie lange Commit-Nachrichten in eine Textdatei schreiben und diese verwenden --Datei Flag, um die Commit-Nachrichten als Inhalt der Textdatei anzugeben.

Zum Beispiel:

git commit --file commit_message.txt

Wenn Sie den obigen Befehl ausführen, verwendet Git den Inhalt der Datei als Commit-Nachricht.

Sie können Git auch anweisen, Ihren Standardeditor zu öffnen, um eine längere Nachricht zu schreiben. Wenn Sie die Umgebungsvariable GIT_EDITOR oder EDITOR festgelegt haben, öffnet Git dieses Programm, wenn Sie ein Bare ausführen Git-Commit Befehl.

Warum Sie gute Commit-Nachrichten schreiben sollten

Das Schreiben guter Commit-Nachrichten ist für eine effektive Zusammenarbeit und Codepflege von entscheidender Bedeutung. Klare und beschreibende Nachrichten erleichtern das Verständnis, das Debuggen und die Codeüberprüfung. Sie können sogar zur Projektdokumentation oder zu Versionshinweisen beitragen.

Sie ermöglichen den Wissensaustausch, ein reibungsloses Onboarding und unterstützen die Versionskontrolle. Durch die Priorisierung hochwertiger Commit-Nachrichten werden Entwicklungsprozesse verbessert und die Wartbarkeit der Codebasis sichergestellt.