Git Commit Formatter (Convention)
Die interaktive UI für perfekte Commit-Messages.
Mit Emojis, Längenwarner und Template-Block.
✨ Generierter Commit
Über das Tool
Ein grafischer Assistent zur schnellen Zusammenstellung von Konventionsbasierten Git Commits. Statt in der Konsole die Typen, Emojis und Klammern von Hand zu tippen, klicken Sie sich durch das Formular und kopieren das fertig gerenderte Template zurück in die Terminal-Oberfläche.
Bedienung
Commit-Kern definieren
Wählen Sie den Scope aus der Liste der 11 Angular-Commit-Standards. Fix oder Feat.
Details hinterlegen
Verfassen Sie einen minimalen Betreff (Achten Sie auf unser Zeichenlimit) und schildern Sie die Umstände darunter ausführlich im Body.
Entnahme via Copy&Paste
Schmeißen Sie den erzeugten String einfach als Flag in "git commit -m" oder in das VIM-Eingabefenster.
Glossar
- Conventional Commits
- Ein strenges Framework für Commits, das unter anderem bestimmt das Typen wie <feat> und <fix> existieren und mit Doppelpunkt getrennt werden.
- Gitmoji
- Eine Ergänzung die zu den Standardbegriffen passende optische Emoijs an den Beginn der Zeile stellt (z.B. Bug = 🐛)
- Subject (Betreff)
- Steht im Commit Header auf oberster Zeile. Darf laut alten Linux-Kernel-Limits maximal 50 Zeichen lang sein.
- Body
- Die detaillierte Beschreibung (durch leere Zeile vom Betreff getrennt). Pro Zeile maximal 72 Zeichen.
- Footer
- Abschluss-Labels zur Verbindung mit Systemen via `Closes #12` oder Hinweisen am Changelog-Parser zu `BREAKING CHANGE`.
- Scope
- Optionales Keyword in den runden Klammern welches die Komponente exakt benennt, z.B: feat(PaymentGateway)
- BREAKING CHANGE
- Signalisiert der Softwarewelt, dass dieses Commit Funktionen komplett restrukturiert und alte Abhängigkeiten zerstören könnte. Meist mit ! markiert.
FAQ
- F.Werden meine Eingaben an einen Server geschickt?
- Nein. Die komplette Nachricht wird direkt in der Browserumgebung gerendert. Ihre Repositories und Commits verlassen niemals Ihr Gerät.
- F.Kann ich eigene Format-Typen verwenden?
- Das Tool bietet die 11 Standard-Typen aus dem Semantic-Release-Kosmos (Conventional Commits). Individuelle Zusätze können Sie dann im Ausgabefenster frei eintippen.
- F.Wie nutze ich dies in Verbindung mit Git-Hooks?
- Um Teamstandards zu erzwingen, sollten Sie im Repository auf 'commitlint'-Hooks zurückgreifen. Dieses UI-basierte Tool eignet sich eher als Begleitung während manueller Commits.
- F.Gibt es das als VS Code Extension?
- Ja, hierfür gibt es die 'Commitizen'-Erweiterung oder ähnliche Plugins. Der Vorteil diese Webtools liegt im portablen Cross-Device-Einsatz ohne vorherige Plugin-Kompilierung im Editor.
- F.Kann ich auch Deutsch/andere Sprachen nutzen?
- Ja. Die Maske unterstützt jede Texteingabe. Die Kategorien (feat, fix) bleiben jedoch meist zwingend englisch — die Beschreibung können Sie aber wie gewünscht verfassen.
Anwendungen
Bessere Code Reviews
Ihre Co-Worker können im Log sofort via Farben und Emotes abscannen, welche Teile nur Doku und welche Bugfixes sind.
Automatisiertes Changelog
Tools wie "semantic release" lesen die standardisierte String-Syntax vollautomatisch aus und erzeugen markttaugliche Release-Protokolle.
Hilfe für Praktikanten
Neue Mitarbeiter neigen zu sehr langen "Hallo, das wurde repariert"-Commits. Mit dem Tool lernen sie schnell den Git-Standard.
Übersicht auf Github behalten
Selbst in Solo-Repos bewirken optische Emojis Wunder wenn diese auf visuell fokussierten GUI-Clients betrachtet werden.