Git-Workflow-Enforcer
Erzwingt konsistente Git-Workflows, einschließlich Commit-Nachrichten, Branch-Benennung und PR-Prozessen.
Wann verwenden
- Erstellen von Commits oder Branches
- Code-Review oder PR-Erstellung
- Benutzer erwähnt "Git-Workflow", "Commit-Nachricht", "Branch-Benennung" oder "Pull-Request"
Anleitung
1. Vorhandene Konventionen erkennen
Prüfe auf:
.github/oder.gitlab/VorlagenCONTRIBUTING.md- Vorhandene Commit-Nachrichten-Muster
- Branch-Benennungsmuster
2. Conventional Commits
Format: typ(bereich): beschreibung
Typen:
feat: Neues Featurefix: Fehlerbehebungdocs: Dokumentationstyle: Formatierung, fehlende Semikolonsrefactor: Code-Umstrukturierungperf: Leistungsverbesserungtest: Hinzufügen von Testschore: Wartung, Abhängigkeiten
Beispiele:
feat(auth): OAuth2-Login-Unterstützung hinzugefügt
fix(api): Null-Antwort in Benutzer-Endpunkt behandelt
docs(readme): Installationsanleitung aktualisiert
refactor(utils): Datumsformatierungslogik vereinfacht
3. Branch-Benennung
Häufige Muster:
feature/user-authentication
bugfix/login-error-handling
hotfix/critical-security-patch
release/v1.2.0
chore/update-dependencies
Validierung:
- Kleinbuchstaben mit Bindestrichen
- Mit Typ-Präfix
- Beschreibender Name
- Issue-Nummer falls zutreffend:
feature/123-add-dark-mode
4. Commit-Nachrichten-Validierung
Guter Commit:
feat(payments): Stripe-Payment-Gateway integriert
- Stripe SDK-Konfiguration hinzugefügt
- Zahlungsintent-Erstellung implementiert
- Webhook-Handler für Zahlungsereignisse hinzugefügt
- Tests für den Zahlungsablauf aktualisiert
Schließt #456
Prüfe auf:
- Betreffzeile ≤50 Zeichen
- Text bei 72 Zeichen umbrechen
- Leerzeile zwischen Betreff und Text
- Imperativ ("hinzufügen" nicht "hinzugefügt")
- Verweis auf Issue/Ticket
5. PR-Vorlage
Erstelle .github/PULL_REQUEST_TEMPLATE.md:
## Beschreibung
<!-- Was macht dieser PR? -->
## Art der Änderung
- [ ] Fehlerbehebung
- [ ] Neues Feature
- [ ] Bahnbrechende Änderung
- [ ] Dokumentationsupdate
## Tests
<!-- Wie wurde dies getestet? -->
## Checkliste
- [ ] Code folgt den Projektstilrichtlinien
- [ ] Selbst-Review abgeschlossen
- [ ] Kommentare für komplexen Code hinzugefügt
- [ ] Dokumentation aktualisiert
- [ ] Tests hinzugefügt/aktualisiert
- [ ] Alle Tests bestehen
- [ ] Keine neuen Warnungen
## Verwandte Issues
Schließt #
6. Commit-Hooks
Pre-Commit:
#!/bin/sh
# .git/hooks/pre-commit
# Linter ausführen
npm run lint
# Tests ausführen
npm test
# Auf sensible Daten prüfen
if git diff --cached | grep -i "password\|api_key\|secret"; then
echo "Fehler: Mögliche sensible Daten erkannt"
exit 1
fi
Commit-msg:
#!/bin/sh
# .git/hooks/commit-msg
commit_msg=$(cat "$1")
# Conventional-Commit-Format prüfen
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|chore)(\(.+\))?: .+"; then
echo "Fehler: Commit-Nachricht muss dem Conventional Commits-Format entsprechen"
echo "Beispiel: feat(auth): Login-Funktion hinzugefügt"
exit 1
fi
7. Vorhandene Commits validieren
Prüfe letzte Commits auf Musterkonformität:
git log --oneline -20 | grep -v "^[a-f0-9]\{7\} (feat|fix|docs|style|refactor|perf|test|chore)"
8. Changelog generieren
Aus conventional commits:
# Mit standard-version
npx standard-version
# Oder manuell nach Typ gruppieren
git log --pretty=format:"%s" | grep "^feat" > features.txt
git log --pretty=format:"%s" | grep "^fix" > fixes.txt
9. Geschützte Branches
GitHub-Einstellungen:
- PR-Reviews erforderlich
- Statusprüfungen erforderlich
- Signierte Commits erforderlich
- Einschränkung, wer pushen darf
- Lineare Historie erforderlich
10. Best Practices
- Atomare Commits: Eine logische Änderung pro Commit
- Beschreibende Nachrichten: Erklären warum, nicht was
- Häufige Commits: Klein, häufig statt groß, selten
- Saubere Historie: Squash/Rebase vor dem Merge
- Commits signieren: GPG-Signatur für Sicherheit
- Issues referenzieren: Verlinkung zum Ticketsystem
Git-Commit-Vorlage
Erstelle .gitmessage:
<typ>(<bereich>): <betreff>
<text>
<fußzeile>
# Typ: feat, fix, docs, style, refactor, perf, test, chore
# Bereich: betroffene Komponente oder Datei
# Betreff: Imperativ, Kleinbuchstaben, kein Punkt, ≤50 Zeichen
# Text: Erkläre was und warum, nicht wie, bei 72 Zeichen umbrechen
# Fußzeile: Bahnbrechende Änderungen, Issue-Verweise
Als Vorlage setzen:
git config --global commit.template ~/.gitmessage
Unterstützende Dateien
templates/PULL_REQUEST_TEMPLATE.mdtemplates/commit-msg-hook.shtemplates/.gitmessage