Was ist ein Git-Commit-Message-Generator?
Ein Git-Commit-Message-Generator hilft Entwicklern, gut strukturierte Commit-Nachrichten nach der Spezifikation Conventional Commits zu erstellen. Herkömmliche Commits bieten ein standardisiertes Format – type(scope): description –, das Commit History lesbar macht, automatisierte Versionierung mit Tools wie semantic-release ermöglicht und Changelog-Generierung vereinfacht. Dieses Tool führt Sie durch jeden Teil der Commit-Nachricht, um die Konsistenz in Ihrem Projekt sicherzustellen.
So verwenden Sie den Git-Commit-Message-Generator
- 1Wählen Sie den Commit-Typ (feat, fix, docs, style, refactor, perf, test, build, ci, chore oder revert) aus dem Dropdown.
- 2Optional geben Sie einen Scope ein, um den Bereich der betroffenen Codebasis anzugeben (z. B. Auth, API, ui).
- 3Schreibe eine kurze Beschreibung der Veränderung der Imperativstimmung.
- 4Optional fügen Sie einen längeren Körper hinzu, um zusätzlichen Kontext über die Änderung bereitzustellen.
- 5Schalten Sie 'Breaking Change' um, wenn der Commit eine brechende API-Änderung einführt, und beschreiben Sie, was kaputt geht.
- 6Optional Fußzeilenreferenzen wie 'Closes #123' oder 'Refs #456' hinzufügen.
- 7Umschalten von 'Include emoji prefix', um ein visuelles Emoji dem Commit-Typ vorzuschieben.
- 8Kopieren Sie die generierte Commit-Nachricht mit dem Copy-Button.
Anwendungsfälle
Semantische Versionierung Automatisierung
Verwenden Sie konventionelle Commits, um Tools wie semantische Freigabe oder Standardversion zu aktivieren, um Versionsunebenheiten (Major, Minor, Patch) basierend auf Commit-Typen automatisch zu bestimmen.
Automatisierte Changelog Generation
Generieren Sie strukturierte Changelogs automatisch aus der Commit-Historie, gruppieren Sie Funktionen, Fehlerbehebungen und brechen Sie Änderungen in organisierte Release-Notizen.
Team Commit Standards
Erzwingen Sie eine konsistente Commit-Nachrichtenformatierung in allen Entwicklungsteams, wodurch Code-Review und Projektverlauf leichter zu navigieren und zu verstehen sind.
Open Source Beiträge
Befolgen Sie weithin akzeptierte Commit-Konventionen, wenn Sie zu Open-Source-Projekten beitragen, die konventionelle Commits für ihre CI / CD-Pipelines erfordern.
Häufig gestellte Fragen
Was ist das Format Conventional Commits?
Konventionelle Commits ist eine Spezifikation zum Schreiben standardisierter Commit-Nachrichten. Das Format lautet: type(scope): description, optional gefolgt von body und footer. Typen wie 'feat' und 'fix' Karte zu MINOR und PATCH semantische Version Bumps beziehungsweise, während eine 'BREAKING CHANGE' Fußzeile oder '!' nach dem Typ eine MAJOR Bump auslöst.
Welchen Commit-Typ sollte ich verwenden?
Verwenden Sie 'feat' für neue Funktionen, 'fix' für Fehlerbehebungen, 'docs' für Dokumentationsänderungen, 'style' für Formatierungsänderungen, 'refactor' für Code-Umstrukturierung, 'perf' für Leistungsverbesserungen, 'test' für Teständerungen, 'build' für Build-Systemänderungen, 'ci' für CI-Konfigurationsänderungen, 'chore' für Wartungsaufgaben und 'revert' für das Zurücksetzen früherer Commits.
Ist der Anwendungsbereich erforderlich?
Nein, der Anwendungsbereich ist optional. Es bietet zusätzlichen Kontext darüber, welcher Teil der Codebasis betroffen ist (z. B. 'auth', 'API', 'ui'). Einige Teams benötigen Bereiche, während andere sie optional lassen - folgen Sie den Konventionen Ihres Projekts.
Was bedeutet die '!' vor dem Dickdarm?
Ein Ausrufezeichen '!', das hinter dem Typ / Umfang und vor dem Doppelpunkt angebracht ist, zeigt eine Bruchänderung an. Zum Beispiel signalisiert 'feat(API)!: change auth endpoint', dass dieser Commit eine brechende API-Änderung einführt, die dem Hinzufügen einer 'BREAKING CHANGE'-Fußzeile entspricht.
Kann ich Emojis in Commit-Nachrichten verwenden?
Ja, viele Teams und Open-Source-Projekte verwenden Emojis als visuelle Präfixe für Commit-Typen (z. B. ︎ für feat, <0xF0><0x9F><0x90><0x9B> für fix). Obwohl sie nicht Teil der offiziellen Spezifikation für konventionelle Commits sind, können Emojis die Lesbarkeit in Commit-Logs und GitHub-Schnittstellen verbessern. Umschalten Sie die Emoji-Option in diesem Tool, um sie aufzunehmen.