Commit-Nachrichten

Warum Commit-Nachrichten wichtig sind

Commit-Nachrichten spielen eine entscheidende Rolle beim Verständnis der Historie eines Projekts. Gut formulierte Commit-Nachrichten erleichtern es Mitarbeitern, zukünftigen Entwicklern und sogar Ihnen selbst, den Zweck und Kontext jeder Änderung zu verstehen. Eine klare Commit-Historie erleichtert die Zusammenarbeit, das Debuggen und den Prozess der Identifizierung spezifischer Änderungen im Zeitverlauf eines Projekts.

Aufbau einer guten Commit-Nachricht

1. Kürze und Klarheit

Eine Commit-Nachricht sollte prägnant und auf den Punkt gebracht sein. Sie sollte den Zweck des Commits in einer einzigen Zeile klar vermitteln. Vermeiden Sie Mehrdeutigkeit und geben Sie genügend Informationen, um die Änderung zu verstehen, ohne den tatsächlichen Code ansehen zu müssen.

2. Betreff vom Text trennen

Wenn mehr Details benötigt werden, trennen Sie den Betreff vom Text der Commit-Nachricht mit einer Leerzeile. Der Betreff sollte die Änderung zusammenfassen, und der Text kann zusätzlichen Kontext, Gründe für die Änderung und relevante Informationen liefern.

Schauen wir uns ein Beispiel für eine solche Commit-Nachricht an:

In diesem Fall werden wir jedoch einfach den git commit Befehl ohne das -m Flag ausführen:

Der Standard-Texteditor für Git wird geöffnet, in dem Sie eine detaillierte Commit-Nachricht schreiben können. Sie sollten diese dann speichern und den Texteditor ordnungsgemäß beenden.

Lassen Sie uns einen weiteren Commit in unserem Repository machen:

Hier ist der Befehl, den wir verwendet haben, um unsere Textdatei zu ändern:

Die Commit-Nachricht lautet wie folgt:

Wenn Sie die Datei nicht bearbeiten können, drücken Sie die i-Taste. Dies stellt sicher, dass Sie in den Bearbeitungsmodus wechseln. Um Änderungen zu speichern und Vim zu verlassen, drücken Sie erneut die Escape-Taste und zwei große Z-Buchstaben.

Hinweis

Wenn Sie einen anderen Standard-Texteditor für das Terminal (außer Vim) haben und auf Schwierigkeiten stoßen, können Sie leicht im Internet finden, wie Sie Änderungen speichern und ihn beenden können.

3. Verwenden Sie den Imperativ

Schreiben Sie Commit-Nachrichten im Imperativ, was eine Richtung für die Änderung vorgibt. Beginnen Sie das Betreff mit einem Verb, wie "Fix," "Add," oder "Update."