Commit-Skill
Änderungen bereitstellen und committen – nach dem Conventional-Commit-Stil und den Prinzipien atomarer Commits.
Commit-Nachrichtenformat
<type>(<optionaler scope>): <kurze zusammenfassung>
- Alles kleinschreiben – Type, Scope und Zusammenfassung
- Kein Punkt am Ende der Zusammenfassung
- Imperativ – „add feature“ nicht „added feature“ oder „adds feature“
- Maximal 50 Zeichen für die Zusammenfassungszeile (weiches Limit, 72 striktes Limit)
- Die Zusammenfassung beschreibt das Warum, nicht das Was (der Diff zeigt das Was)
Typen
| Typ | Verwendung | Beispiel |
|---|---|---|
feat | Neue Funktion oder Fähigkeit | feat: add user authentication flow |
fix | Fehlerbehebung | fix: resolve null pointer on empty input |
refactor | Codeänderung, die weder Fehler behebt noch Funktion hinzufügt | refactor: extract parser into standalone module |
style | Formatierung, Leerzeichen, Semikolons – keine Logikänderung | style: apply formatter to config files |
docs | Nur Dokumentation | docs: add API usage examples to readme |
test | Hinzufügen oder Aktualisieren von Tests | test: add edge case coverage for validator |
chore | Build-Prozess, Tooling, Abhängigkeiten, Konfiguration | chore: update dependency lockfile |
perf | Leistungsverbesserung | perf: cache repeated database lookups |
ci | CI/CD-Pipeline-Änderungen | ci: add lint step to PR workflow |
Scope (Optional)
Verwende Scope, um den Kontext einzugrenzen, wenn der Typ allein mehrdeutig ist. Leite Scopes aus der Verzeichnisstruktur des Projekts oder aus Fachbereichen ab:
feat(auth): add OAuth2 token refresh
fix(api): handle timeout on large payloads
docs(contributing): add setup instructions
Workflow
- Änderungen überprüfen – Führe
git statusundgit diff(bereitgestellt + nicht bereitgestellt) aus, um zu verstehen, was geändert wurde - Letzte Historie prüfen – Führe
git log --oneline -10aus, um den bestehenden Commit-Stil des Projekts zu erkennen - Absicht bestätigen – Stelle sicher, dass die Änderungen eine einzelne logische Einheit bilden; falls nicht, schlage vor, sie in mehrere Commits aufzuteilen
- CI-Checks ausführen – Führe vor dem Bereitstellen die Linter, Formatierer und Testsuiten des Projekts aus, um Probleme früh zu erkennen. Überprüfe
package.json-Skripte,Makefileoder CI-Konfiguration auf verfügbare Befehle. Behebe alle Fehler, bevor du fortfährst. - Dateien bereitstellen – Füge bestimmte Dateien namentlich hinzu (
git add datei1 datei2), niemalsgit add -Aodergit add . - Nachricht verfassen – Wähle den richtigen Typ, füge bei Bedarf einen Scope hinzu, schreibe eine imperative Zusammenfassung
- Commit ausführen – Verwende einen Here-Doc für die Nachricht, um saubere Formatierung sicherzustellen
- Überprüfen – Führe nach dem Commit
git statusaus, um zu bestätigen, dass der Commit erfolgreich war
Mehrzeilige Commits
Für Commits, die einen Body benötigen (selten – bevorzuge präzise einzeilige Nachrichten):
<type>(<scope>): <zusammenfassung>
<body erklärt das warum, nicht das was>
- Leerzeile zwischen Zusammenfassung und Body
- Body bei 72 Zeichen umbrechen
- Body nur verwenden, wenn die Zusammenfassung allein die Begründung nicht vermitteln kann
Regeln
- Atomare Commits – Eine logische Änderung pro Commit. Eine Funktion und ihre Tests können ein Commit sein. Eine nicht zusammenhängende Formatierungskorrektur sollte ein separater Commit sein.
- Keine Secrets – Niemals
.env, Anmeldeinformationen, API-Schlüssel oder Tokens committen. Warne den Benutzer, wenn diese bereitgestellt wurden. - Keine generierten Artefakte – Baue Ausgaben, Abhängigkeitsverzeichnisse oder kompilierte Dateien nicht committen. Überprüfe die
.gitignore-Abdeckung vor dem Bereitstellen. - Nur neue Commits – Erstelle immer einen neuen Commit. Ändere niemals einen bestehenden Commit (amend), es sei denn, der Benutzer fordert es explizit an.
- Keine Hooks überspringen – Verwende niemals
--no-verify. Wenn ein Hook fehlschlägt, behebe das zugrunde liegende Problem. - Co-Author-Zeile – Füge den Co-Author-Trailer hinzu, wenn Claude die Änderungen verfasst oder mitverfasst hat:
Co-Authored-By: Claude <[email protected]>
Beispiele
# Feature – neue Fähigkeit
feat: add webhook notification system
# Feature mit Scope
feat(api): add rate limiting middleware
# Fix – Fehlerkorrektur
fix: prevent crash on malformed JSON input
# Style – nur Formatierung
style: apply consistent indentation across modules
# Docs – Dokumentation
docs: add architecture decision records
# Chore – Tooling/Konfiguration
chore: broaden gitignore to cover build artifacts
# Test mit Scope
test(auth): add integration tests for token refresh
# Refactor mit Scope
refactor(db): replace raw queries with query builder
Referenzdokumentation
- conventional-commits.md – Typauswahl-Leitfaden, Breaking Changes, Scope-Strategien, Entscheidungen bei mehreren Dateien, Body-Formatierung, Trailer und häufige Fehler