Commit-Nachrichten-Generator

Was eine Commit-Message ausmacht

Eine Commit-Message ist die kurze Notiz, die im Diff auftaucht, der Typ, der die Codebase sortiert, und die Absicht, die der zukünftige Entwickler versteht. Der Kodex des Geschichtenerzählers beschwört Messages, die diese Klarheit tragen, präzise genug für eine PR-Beschreibung, lesbar genug für eine Code-Review.

Die Form einer zukünftigen Debug-Sitzung

Starke Commit-Messages setzen auf einen Typ, einen Umfang, eine Absicht, oft kombiniert mit einer kurzen Begründung. Die Schreiber balancieren die Klarheit mit der Kürze, vermeiden jeden Lärm, der nicht in einer PR-Beschreibung tragend klingt, und vergessen nie, dass der zukünftige Entwickler der Leser ist.

Für Open-Source-PRs, Dev-Workflow und Self-Hosting

Wirf Messages für einen ersten Commit in einem neuen Repo, einen Hotfix in einer produktiven Codebase, eine Refactor-PR in einem Open-Source-Projekt, eine Concept-Art-Szene in einem Drehbuch über die Tech-Welt, eine Social-Media-Ankündigung mit klarem Dev-Motto, oder eine Tabletop-Szene, in der die Spielergruppe eine Code-Review durchführen. Der Kodex füllt jeden Diff und jede PR.

Tipps der Diff-Schreiber

Setze auf den Typ. Eine Commit-Message ohne Typ klingt nach Notiz, nicht nach Commit. Ehre den Umfang. Die schönsten Messages tragen einen konkreten Bereich, ohne ihn zu erklären. Bewahre ein paar Feinheiten für die seltene PR-Beschreibung, für die Code-Review-Antwort und für den einen Commit, der im Finale die ganze Codebase trägt.

Fragen, bevor du wirfst

Bevor du eine Commit-Message wählst, überlege:

• Welcher Typ steht im Zentrum, feat, fix, refactor, docs, test?
Trägt die Message einen Umfang, eine Begründung oder eine Absicht?Würde die Message in einer PR-Beschreibung und in einer Code-Review gleich gut tragen?Deutet sie auf eine Funktion, einen Fix oder ein Geheimnis?Wird die Message in der dritten Iteration weitergetragen, oder endet sie mit dem Release?