Git-Commit-Nachrichtengenerator
Schreiben Sie klare, konventionelle Commit-Nachrichten gemäß Conventional Commits oder dem Format Ihres Teams. Inklusive Scope, Typ und Breaking-Change-Indikatoren.
Anleitung Git-Commit-Nachrichtengenerator
- Describe the changes you made in plain language — what files changed, what behavior is different, and why you made the change.
- Wählen Sie die Commit-Konvention Ihres Teams (Conventional Commits ist am weitesten verbreitet).
- Wählen Sie den Änderungstyp, der Ihre Änderung am besten kategorisiert — „feat“ für neue Funktionen, „fix“ für Fehlerbehebungen, „refactor“ für Umstrukturierungen.
- Fügen Sie optional einen Scope hinzu, um den Kontext einzugrenzen (z.B. 'auth' für Authentifizierungsänderungen, 'ui' für Frontend-Updates).
Anwendungsfälle
Schreiben Sie konsistente Commit-Nachrichten im gesamten Entwicklerteam
Generieren Sie Commit-Nachrichten, die mit automatisierten Changelog-Generatoren funktionieren
Erstellen Sie beschreibende Commits für Open-Source-Beiträge und Pull Requests
Dokumentieren Sie komplexe Refactoring-Änderungen mit klarem Vorher/Nachher-Kontext
Tipps für beste Ergebnisse
- Beschreiben Sie das „Warum“, nicht nur das „Was“ – das hilft, Commit-Beschreibungen zu generieren, die zukünftigen Entwicklern wertvollen Kontext bieten.
- Use specific scopes for monorepos: 'api', 'web', 'shared', 'infra' — this makes git log filtering much more useful.
- Für Breaking Changes erwähnen Sie, wie das alte Verhalten war und wie es jetzt ist — der Generator formatiert einen korrekten BREAKING CHANGE-Footer.
- Das Conventional-Commits-Format ermöglicht automatisches Versions-Bumping und Changelog-Generierung mit Tools wie semantic-release und standard-version.
Häufig gestellte Fragen
Was ist Conventional Commits?
Conventional Commits ist eine Spezifikation für Commit-Nachrichten, die ein strukturiertes Format bietet: type(scope): description. Sie ermöglicht automatische Changelog-Generierung, semantische Versionierung und macht die Git-Historie durchsuchbar. Es ist die am weitesten verbreitete Commit-Konvention in der Branche.
Sollte ich die Nur-Betreff- oder die detaillierte Version verwenden?
Verwenden Sie nur den Betreff für kleine, selbsterklärende Änderungen (Tippfehler, Dependency-Updates). Verwenden Sie die detaillierte Version mit Body für Feature-Ergänzungen, Bugfixes, Refactorings oder jede Änderung, bei der zukünftige Entwickler vom Verständnis der Begründung profitieren.
Welchen Umfang sollte ich verwenden?
Scopes repräsentieren den betroffenen Bereich der Codebasis: „auth“ für Authentifizierung, „api“ für REST-Endpunkte, „ui“ für Frontend-Komponenten, „db“ für Datenbankänderungen, „ci“ für Pipeline-Änderungen. Verwenden Sie Scopes konsistent in Ihrem Team — lassen Sie sie für querschnittliche Änderungen leer.
Wie hilft das bei Changelogs?
Das Conventional Commits-Format ist maschinenlesbar. Tools wie semantic-release, standard-version und release-please können Ihre Commits analysieren, um automatisch kategorisierte Changelogs (Features, Bug Fixes, Breaking Changes) zu erstellen und Versionsnummern zu bestimmen.
Was ist die 72-Zeichen-Regel?
Git und viele Tools zeigen die erste Zeile einer Commit-Nachricht als Zusammenfassung an. Betreffzeilen unter 72 Zeichen stellen sicher, dass sie in git log, GitHub und IDE-Oberflächen vollständig angezeigt werden, ohne abgeschnitten zu werden. Der Body sollte ebenfalls bei 72 Zeichen umgebrochen werden, um die Lesbarkeit im Terminal zu gewährleisten.
Wir speichern Ihren Text nicht. Die Verarbeitung erfolgt in Echtzeit und Ihre Eingabe wird sofort nach der Ergebnisgenerierung verworfen.
Unbegrenzten Zugang freischalten
Kostenlos: 10 Nutzungen pro Tag | Pro: Unbegrenzt