Carstens Blog

Gute commit-Messages

Veröffentlicht in Blog.

Es gibt ein Für und Wider in langwierigen und endlosen Debatten im Internet zum Thema „Wie schreibt man Commit-Nachrichten“. Es scheint ein hartes und schwieriges Thema zu sein. Wir sollten uns als Team auf einen Weg einigen. Ich persönlich finde diese Richtlinien https://chris.beams.io/posts/git-commit/ richtig gut und versuche mit daran zu halten.

„Eine richtig geschriebener Git-Commit-Betreff sollte immer in der Lage sein, den folgenden Satz zu vervollständigen: Wenn angewendet, wird dieser commit hier folgendes ändern.“ Zum Beispiel: „Wenn angewandt, wird dieser Commit das Subsystem X für die Lesbarkeit überarbeiten.“

Eine weitere gute Quelle, ist die Webseite https://www.conventionalcommits.org/en/v1.0.0/