Commit-Nachrichten

Warum Commit-Nachrichten wichtig sind

Commit-Nachrichten sind entscheidend, um die Historie eines Projekts nachzuvollziehen. Klare und aussagekräftige Nachrichten helfen Mitwirkenden, zukünftigen Entwicklern und Ihnen selbst, den Zweck und Kontext jeder Änderung zu verstehen. Eine gut strukturierte Commit-Historie verbessert die Zusammenarbeit, vereinfacht das Debugging und erleichtert das Nachverfolgen spezifischer Änderungen im Projektverlauf.

Aufbau einer guten Commit-Nachricht

1. Prägnanz und Klarheit

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

Bad: "Fixed a bug"
Good: "Fix issue with user authentication in login form"

2. Trennung von Betreff und Nachrichtentext

Wenn weitere Details erforderlich sind, den Betreff von dem Nachrichtentext der Commit-Nachricht durch eine Leerzeile trennen. Der Betreff sollte die Änderung zusammenfassen, während der Nachrichtentext zusätzlichen Kontext, Gründe für die Änderung und relevante Informationen liefern kann.

Hier ein Beispiel für eine solche Commit-Nachricht:

Subject: "Add validation for user email input"

Body: "This commit introduces email format validation to ensure
that users provide a valid email address when registering. It
helps improve the overall data integrity of the system."

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

git commit

Der standardmäßige Texteditor für Git wird geöffnet, in dem eine ausführliche Commit-Nachricht verfasst werden kann. Anschließend sollte diese gespeichert und der Texteditor ordnungsgemäß beendet werden.

Im Folgenden wird ein weiterer Commit im Repository durchgeführt:

Hier ist der Befehl, um die Textdatei zu ändern:

echo "Git is the most popular VCS in the world used by millions of developers since it allows efficient collaboration via committing, reverting and merging changes. Besides, Git is free and open source and can be easily installed on Windows, macOS, Linux and all Unix-based platforms." >> test.txt

Die Commit-Nachricht lautet wie folgt:

Subject: "Add description of Git"
  
Body: "This commit introduces brief description 
of Git and highlights its key features. It also 
states the reasons for the widespread popularity 
of Git."

Wenn Sie die Datei nicht bearbeiten können, drücken Sie die i-Taste. Dadurch gelangen Sie in den Bearbeitungsmodus. Um Änderungen zu speichern und Vim zu verlassen, drücken Sie anschließend die Escape-Taste und zweimal den Großbuchstaben Z.

3. Verwendung des Imperativs

Commit-Nachrichten im Imperativ formulieren, um eine klare Handlungsanweisung für die Änderung zu geben. Den Betreff mit einem Verb beginnen, wie zum Beispiel "Fix", "Add" oder "Update".

Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"