Commit-Nachricht-Generator
Baue eine saubere Conventional-Commit-Nachricht Feld für Feld auf: Typ, optionaler Scope, ein kurzer Betreff im Imperativ, ein umbrochener Body, ein BREAKING-CHANGE-Hinweis und Issue-Verweise. Jede Regel wird beim Tippen geprüft, und du kannst die Nachricht oder einen fertigen git-commit-Befehl kopieren.
Zuletzt aktualisiert:
Imperativ, kleingeschrieben, kein Punkt. Vervollständige den Satz "If applied, this commit will …"
Commit-Nachricht
Prüfungen
Ergebnis
Anleitung: Commit-Nachricht-Generator
- Wähle den Typ, der zur Änderung passt: feat für ein neues Feature, fix für eine Fehlerbehebung, docs, refactor und so weiter.
- Füge einen Scope hinzu (optional), etwa api, auth oder ui, um anzugeben, welcher Teil des Codes sich geändert hat.
- Schreibe den Betreff im Imperativ, kleingeschrieben und ohne Punkt: "add password reset", nicht "Added password reset."
- Erkläre das Warum im Body, wenn die Änderung Kontext braucht, aktiviere dann Breaking Change und beschreibe, was Nutzer tun müssen, falls die Änderung nicht abwärtskompatibel ist.
- Füge Issue-Verweise hinzu, prüfe die Ergebnisse und kopiere die Nachricht oder den git-commit-Befehl.
Conventional-Commit-Format
Die Spezifikation Conventional Commits 1.0.0 strukturiert eine Commit-Nachricht so:
<type>[optional scope][!]: <description> [optional body] [optional footer(s)]
- Header: die einzige Pflichtzeile. Ein Typ, ein optionaler Scope in Klammern, ein optionales
!für Breaking Changes, ein Doppelpunkt, ein Leerzeichen und eine kurze Beschreibung. - Body: freier Text nach einer Leerzeile. Erkläre, was sich geändert hat und warum, nicht wie; das Wie zeigt bereits der Diff.
- Footer: nach einer weiteren Leerzeile, einer pro Zeile in der Form
Token: valueoderToken #value, etwaBREAKING CHANGE: …,Refs: #123oderCo-authored-by: Name <email>.
Typen und Versionssprünge
| Typ | Verwenden für | Beispiel | SemVer-Sprung* |
|---|---|---|---|
feat | Neue Funktionen für Nutzer | feat(cart): füge Gutscheinfeld hinzu | Minor (1.4.0 → 1.5.0) |
fix | Fehlerbehebungen | fix(api): gib 404 für unbekannte IDs zurück | Patch (1.4.0 → 1.4.1) |
perf | Verbesserungen bei Geschwindigkeit oder Speicher | perf: speichere geparste Templates im Cache | Patch |
refactor | Umstrukturierung ohne Verhaltensänderung | refactor(db): lagere Query-Builder aus | Keiner |
docs | Nur Dokumentation | docs: erkläre Umgebungsvariablen in der README | Keiner |
style | Formatierung, Leerraum, Linting-Korrekturen | style: wende prettier auf src an | Keiner |
test | Tests hinzufügen oder korrigieren | test(auth): teste abgelaufene Tokens | Keiner |
build | Build-Tools und Abhängigkeiten | build(deps): hebe vite auf 5.4 an | Keiner |
ci | CI-Pipelines und -Skripte | ci: cache npm in GitHub Actions | Keiner |
chore | Wartung, die weder Quellcode noch Tests betrifft | chore: aktualisiere .editorconfig | Keiner |
revert | Rückgängigmachen eines früheren Commits | revert: feat(cart): füge Gutscheinfeld hinzu | Unterschiedlich |
beliebiger Typ + ! oder BREAKING CHANGE: | Änderungen, die nicht abwärtskompatibel sind | feat(api)!: entferne v1-Endpunkte | Major (1.4.0 → 2.0.0) |
*Standardverhalten von semantic-release und standard-version mit dem Angular-/Conventional-Preset. Viele Teams konfigurieren perf, refactor oder docs anders.
Längenregeln, die dieses Tool prüft
- 50 Zeichen für den Header sind die klassische Richtlinie (aus dem Git-Projekt und "How to Write a Git Commit Message"): Das passt in
git log --oneline, GitHub-Commit-Listen und E-Mail-Betreffzeilen. - 72 Zeichen sind die übliche harte Grenze für den Header und die Umbruchbreite für Body-Zeilen, weil
git logden Body um 4 Leerzeichen einrückt und trotzdem in ein Terminal mit 80 Spalten passen soll. - 100 Zeichen sind die Standardwerte von commitlint für
header-max-lengthundbody-max-line-lengthin@commitlint/config-conventional; längere Zeilen fallen beim Linting durch. URLs werden nicht gezählt, da sie sich nicht umbrechen lassen.
Tipp: Braucht der Betreff das Wort "and", macht der Commit wahrscheinlich zwei Dinge. Ihn aufzuteilen erleichtert Reviews, Reverts und git bisect. Die Git-Befehle zum Ändern, Zusammenfassen oder Umformulieren eines Commits findest du im Git-Spickzettel.
Häufige Fragen
Was ist ein Conventional Commit?
Conventional Commits ist eine schlanke Spezifikation für Commit-Nachrichten. Die erste Zeile hat die Form type(scope): description, zum Beispiel fix(parser): handle empty input. Optionale Body- und Footer-Absätze folgen nach einer Leerzeile. Durch diese Struktur können Tools automatisch Changelogs erzeugen und über semantische Versionssprünge entscheiden.
Welche Commit-Typen kann ich verwenden?
Die Spezifikation selbst definiert nur feat und fix. Das weit verbreitete Preset commitlint config-conventional, das auf der Angular-Konvention basiert, erlaubt außerdem build, chore, ci, docs, perf, refactor, revert, style und test. Diese 11 Typen werden hier angeboten.
Wie markiere ich einen Breaking Change?
Setze ein Ausrufezeichen vor den Doppelpunkt, wie in feat(api)!: remove v1 endpoints, und/oder füge einen Footer hinzu, der mit BREAKING CHANGE: beginnt, gefolgt von einer Beschreibung. Ein Breaking Change löst in semantic-release und ähnlichen Tools einen Major-Versionssprung aus, unabhängig vom Commit-Typ.
Wie lang sollte ein Commit-Betreff sein?
Strebe 50 Zeichen oder weniger für die gesamte erste Zeile an, damit sie in git log --oneline, auf GitHub und in den meisten Tools vollständig sichtbar ist. 72 Zeichen sind eine übliche harte Grenze, und die Standardeinstellung header-max-length von commitlint liegt bei 100. Body-Zeilen werden meist bei 72 Zeichen umbrochen.
Warum sollte der Betreff im Imperativ stehen?
Git selbst schreibt Nachrichten wie Merge branch 'x' und Revert 'y', daher liest sich ein Betreff, der den Satz 'If applied, this commit will ...' vervollständigt, einheitlich: 'add login form', nicht 'added login form' oder 'adds login form'.
Wie schließe ich ein GitHub- oder GitLab-Issue per Commit?
Setze ein Schließ-Schlüsselwort und die Issue-Nummer in den Footer, zum Beispiel Closes #42 oder Fixes #42. GitHub schließt das Issue, wenn der Commit den Standard-Branch erreicht; GitLab unterstützt dieselben Schlüsselwörter. Refs #42 verknüpft das Issue, ohne es zu schließen.
Wie verwende ich eine mehrzeilige Nachricht mit git commit?
Jedes -m-Flag wird zu einem eigenen Absatz, getrennt durch eine Leerzeile, daher erzeugt git commit -m 'header' -m 'body' -m 'footer' eine korrekt formatierte Nachricht. Der erzeugte Befehl nutzt diese Form mit sicherem Quoting für Bash oder PowerShell.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.