Commit-Message-Generator
Commit-Message-Generator für Conventional Commits: Typ, Scope und Beschreibung wählen, Breaking Change und Tickets ergänzen, Regeln prüfen und den fertigen git-Befehl kopieren.
Alles läuft in Ihrem Browser. Eingaben verlassen Ihr Gerät nicht.
Commit-Nachricht nach Conventional Commits
Der Commit-Message-Generator setzt eine Commit-Nachricht nach der Spezifikation Conventional Commits 1.0.0 zusammen: Typ, optionaler Scope, Doppelpunkt, Kurzbeschreibung, darunter ein Textkörper und Fußzeilen. Dazu liefert er den fertigen Befehl git commit mit korrekt maskierten Anführungszeichen für bash oder PowerShell. Eine saubere git commit Message hilft beim Review, bei git log und beim Erzeugen von Changelogs.
Die Commit-Typen feat und fix sind in der Spezifikation festgelegt und entsprechen Neben- und Patch-Version in Semantic Versioning. Die übrigen (docs, style, refactor, perf, test, build, ci, chore, revert) stammen aus der verbreiteten Angular-Konvention und dem commitlint-Standard. Ein Breaking Change wird mit ! nach Typ oder Scope und einer Fußzeile BREAKING CHANGE: markiert; er erhöht bei Semantic Versioning die Hauptversion.
Bewährte Regeln, die der Generator prüft: Kopfzeile möglichst unter 50, höchstens 72 Zeichen, kein Punkt am Ende, Beschreibung im Imperativ („add“, „fix“, auf Deutsch „hinzufügen“, „beheben“), Textkörper bei 72 Zeichen umbrochen und durch eine Leerzeile getrennt. Ob Ihr Team Deutsch oder Englisch schreibt, entscheidet die Projektkonvention; wichtig ist, dabei zu bleiben. Aus vielen solchen Zeilen erzeugt der Changelog-Generator die Versionshinweise; gängige Befehle stehen im Git-Spickzettel.
Anleitung: Commit-Message-Generator in 4 Schritten
- Typ wählen, etwa feat für eine neue Funktion oder fix für eine Fehlerbehebung, und optional einen Scope eintragen.
- Die Kurzbeschreibung im Imperativ ohne Punkt schreiben und bei Bedarf eine ausführliche Beschreibung ergänzen.
- Bei inkompatiblen Änderungen „Breaking Change“ ankreuzen und erklären, dazu Tickets und Co-Autor angeben.
- Den Befehl für bash, zsh, Git Bash oder PowerShell wählen und Commit-Nachricht oder fertigen git-Befehl kopieren.
Typische Anwendungsfälle
- Conventional Commits einführen: Dem Team einheitliche Commit-Nachrichten erleichtern, bis die Regeln sitzen.
- commitlint bestehen: Kopfzeile, Länge und Typ vorab prüfen, damit der Commit-Hook nicht ablehnt.
- Changelog vorbereiten: Saubere feat- und fix-Commits schreiben, aus denen Werkzeuge Versionshinweise erzeugen.
- Gemeinsam arbeiten: Beim Pair Programming die Kollegin oder den Kollegen als Co-Autor eintragen.
Häufige Fragen
Wie ist eine Conventional-Commit-Nachricht aufgebaut?
typ(scope): beschreibung in der ersten Zeile, optional nach einer Leerzeile ein Textkörper und danach Fußzeilen wie BREAKING CHANGE: … oder Refs: #123.
Welche Commit-Typen gibt es?
Pflicht laut Spezifikation sind nur feat und fix. Üblich sind außerdem docs, style, refactor, perf, test, build, ci, chore und revert, wie sie commitlint mit der Konfiguration config-conventional erlaubt.
Wie lang darf die erste Zeile sein?
Die Spezifikation schreibt keine Länge vor. Bewährt sind höchstens 50 Zeichen, 72 als Obergrenze, weil GitHub und viele Werkzeuge längere Zeilen abschneiden. commitlint prüft standardmäßig 100 Zeichen für die gesamte Kopfzeile.
Wie markiere ich einen Breaking Change?
Mit einem Ausrufezeichen vor dem Doppelpunkt, etwa feat(api)!: …, und zusätzlich mit einer Fußzeile BREAKING CHANGE: Beschreibung. Eines von beidem genügt laut Spezifikation.
Warum zwei -m im git-Befehl?
Jedes -m erzeugt einen eigenen Absatz. So entstehen Kopfzeile, Textkörper und Fußzeilen mit den nötigen Leerzeilen, ohne dass ein Editor geöffnet wird.
Wie ändere ich die letzte Commit-Nachricht?
Mit git commit --amend -m "neue Nachricht", solange der Commit noch nicht gepusht ist. Liegt er schon auf dem Server, ändert das die Historie, und das erneute Pushen braucht git push --force-with-lease.
Wie füge ich einen Co-Autor zu einem Commit hinzu?
Mit einer Fußzeile Co-authored-by: Name <name@example.com> am Ende der Nachricht, getrennt durch eine Leerzeile. GitHub zeigt die Person dann als Mitautor an, wenn die E-Mail zu ihrem Konto gehört.
Das könnte auch helfen
Cron-Ausdruck erklären
Crontab-Zeilen mit 5 oder 6 Feldern auf Deutsch erklärt, mit den nächsten 10 Ausführungen.
ÖffnenCron-Generator
Zeitplan im Formular wählen und die fertige Crontab-Zeile kopieren.
ÖffnenUnix-Zeitstempel umrechnen
Timestamp in Datum und zurück, Sekunden und Millisekunden erkannt, UTC und Berlin.
ÖffnenUUID-Generator
UUID v4 und v7 erzeugen, bis zu 1.000 auf einmal, und vorhandene UUIDs prüfen.
ÖffnenULID-Generator
Sortierbare IDs in Crockford Base32 erzeugen, dekodieren und in UUID umwandeln.
ÖffnenTexte vergleichen (Diff)
Unterschiede zwischen zwei Texten zeilen-, wort- oder zeichenweise finden.
Öffnen