Was macht conventional-commit?
Anleitung und Workflow zum Erstellen von konventionellen Commit-Nachrichten mithilfe eines strukturierten XML-Formats. Führt Benutzer durch die Erstellung standardisierter, beschreibender Commits gemäß der Conventional Commits-Spezifikation, inklusive Anleitung, Beispielen und Validierung.
Übersicht
Dieser Skill hilft Ihnen, Commit-Nachrichten zu erstellen, die dem Conventional Commits-Standard entsprechen. Er stellt sicher, dass jede Nachricht einen klaren Typ, eine optionale Angabe des Umfangs und eine präzise Beschreibung enthält.
Verwendung
- Staging: Stellen Sie Ihre Änderungen mit
git addbereit. - Ausführung: Führen Sie den Skill aus und geben Sie den Kontext der Änderungen an.
- Validierung: Der Skill validiert die generierte Nachricht gegen die Spezifikation und gibt sie im XML-Format aus.
Unterstütztes Format
<commit>
<type>feat</type>
<scope>api</scope>
<description>Neuen Endpunkt für Benutzerabfrage hinzugefügt</description>
</commit>
Typen
| Typ | Beschreibung | Beispiel |
|---|---|---|
feat | Ein neues Feature | feat: Suchfunktion hinzugefügt |
fix | Ein Fehlerbehebung | fix: Absturz bei leerer Eingabe behoben |
docs | Dokumentationsänderungen | docs: README aktualisiert |
style | Code-Stil-Änderungen (keine funktionalen Änderungen) | style: Einrückung korrigiert |
refactor | Code-Refactoring ohne Funktionsänderung | refactor: Datenbankabfrage optimiert |
test | Tests hinzugefügt oder aktualisiert | test: Unit-Tests für Login erweitert |
chore | Wartungsaufgaben, Build-Prozess, etc. | chore: Abhängigkeiten aktualisiert |
Beispiele
feat(authentication): JWT-Token-Unterstützung hinzugefügtfix(database): Korrektur des NULL-Handlings in der Abfragedocs: Installationsanleitung präzisiertrefactor(api): API-Endpunkte in separate Module aufgeteilttest(utils): Testabdeckung für Hilfsfunktionen erhöht
Validierung
Der Skill validiert jede generierte Commit-Nachricht anhand der folgenden Regeln:
- Der Typ muss aus der Liste der unterstützten Typen stammen.
- Die Beschreibung darf maximal 72 Zeichen lang sein.
- Bei Änderungen, die die Abwärtskompatibilität brechen, muss ein
!nach dem Typ/Umfang hinzugefügt werden (z. B.feat!). - Der Umfang ist optional, aber wenn er angegeben wird, sollte er in Klammern nach dem Typ stehen.
Plattformunterstützung
Dieser Skill wurde für den Einsatz mit KI-Agenten wie Claude Code, Cursor und Codex optimiert, die strukturierte XML-Eingabe und -Ausgabe unterstützen.