Читать книгу GitHub – Eine praktische Einführung - Anke Lederer - Страница 30

Commit-Nachrichten bei GitHub bestehen aus zwei Teilen: dem Titel und einer (optionalen) detaillierteren Beschreibung. Den Titel solltest du immer aussagekräftig befüllen, damit jede und jeder (und auch du in ein paar Monaten) weiß, was du mit dem Commit bewirken wolltest. GitHub selbst gibt dazu folgende Empfehlungen, ergänzt um meine Tipps:

 Der Commit-Titel sollte nicht mit einem Punkt aufhören, da es sich um eine Überschrift handelt.

 Der Titel sollte nicht aus mehr als 50 Zeichen bestehen (Leerzeichen mitgezählt), siehe Abbildung 3-11.12 Für detailliertere Informationen dient darunter das Feld extended description (»erweiterte Beschreibung«).

 Benutze aktive Sprache, keine passive, also »füge hinzu« anstatt »hinzugefügt« (im Englischen »add« anstatt »added«). Am einfachsten ist es, wenn man sich den Commit-Titel wie einen Befehl ans System denkt: »Ändere dies!«

 Versuche, mit dem Titel deine Absicht auszudrücken.

 Versuche, das Was und Warum zu beschreiben (z.B.: »Restrukturiere Modul A für bessere Lesbarkeit«).

 Schreibe die Nachricht so, dass auch du sie in fünf Jahren noch verstehen kannst.

Abbildung 3-11: Wer mehr als 50 Zeichen eintippt, bekommt von GitHub einen entsprechenden Hinweis.

Ein schönes Zitat, das gut verdeutlicht, wieso präzise und klare Commit-Nachrichten so wichtig sind, ist Folgendes:

Jedes Softwareprojekt ist ein gemeinschaftliches Projekt. Es hat mindestens zwei Entwickler, den ursprünglichen Entwickler und den ursprünglichen Entwickler ein paar Wochen oder Monate später, wenn der Gedankengang längst den Bahnhof verlassen hat.

– Who-T, On commit messages, unter https://who-t.blogspot.com/2009/12/on-commit-messages.html (Übersetzung von deepl.com)

Nachdem du alle Änderungen dem Projekt hinzugefügt (bzw. committet) hast, gehe auf die Startseite des Projekts und bewundere das neue Erscheinungsbild. Genieße diesen Augenblick! Nichts ist so toll wie der erste Commit, der sofort auch optisch etwas verändert. Wenn du die README.md erneut anklickst, bekommst du noch ein paar Zusatzinformationen, wie beispielsweise die Anzahl der Mitwirkenden oder die Dateigröße (siehe Abbildung 3-12).

Abbildung 3-12: Durch Anklicken einer Datei erhält man weitere Zusatzinformationen.