- Warum man gute Commit-Messages schreiben sollte
- Konsistente und klare Commit-Messages helfen anderen Entwicklerinnen und Entwicklern, Änderungen leichter zu verstehen
- Mit guten Commit-Messages lassen sich Probleme im Code leichter debuggen
- Gut geschriebene Git-Commit-Messages vermitteln anderen Mitwirkenden am Projekt und dem zukünftigen eigenen Ich den Kontext der Änderungen
- So schreibt man gute Commit-Messages
- Am Anfang den Commit-Typ angeben, damit sofort klar ist, worum es im Commit geht
- Aus Rücksicht auf andere eine ausführliche Commit-Message schreiben (
commit body verwenden)
- Commit-Messages im befehlenden oder auffordernden Ton formulieren
- Unnötige Satzzeichen weglassen
- Die im Team definierte „Commit Convention“ befolgen
- Die Commit Convention des Product-Teams von Infograb
- Je nach Commit-Art Emojis hinzufügen, damit die Übersicht auf einen Blick leichter fällt
- Um Komponenten, Seiten und Funktionen zu unterscheiden, Komponenten großschreiben und Seiten sowie Funktionen kleinschreiben
- Mit dem
commit body Details zum Commit hinzufügen
- Für prägnante Commit-Messages das Wort „function“ zu „Funktion“ verkürzen
2 Kommentare
Dem Punkt, dass Emojis die Lesbarkeit verbessern, kann ich wirklich nur schwer zustimmen. Wenn man nur drei verwendet, vielleicht noch ...
Dieser Artikel ist ebenfalls gut.
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/