//
Zum Hauptinhalt springen

Git Kommentare - lieber aussagekräftig

Jeder Commit sollte einen aussagekräftigen Kommentar enthalten. Dieser kann gerne kurz, sollte aber prägnant sein.

Dabei gehört für mich IMMER eine Ticketnummer dazu, gefolgt von einer Beschreibung was getan wurde. Das sollte nicht nur der Titel des Tickets sein. Sonst erhält man in der History recht schnell dutzende Einträge mit exakt demselben Kommentar.

Ein Beispiel für einen gut gewählten Kommentar wäre:

CMS-854 added quicksave funtionality in edit mode

Wenn man sich genauer damit beschäftigen will und die eine oder andere zus. Feinheit integrieren möchte lohnt sich das Lesen von

Conventional Commits

Mein Dank geht an Frank ;-) für den klasse Hinweis, dass dazu schon ausführlich geschrieben wurde.