IDE-Tools · Foto: Homedust, CC BY 2.0
commit.mdc
Zuletzt aktualisiert:
Typ
Rule
Lizenz
MIT
Anwendungsfeld
Windsurf Rules & Cross-IDE-Rules
Saubere Git-Historie
Voraussetzungen
Keine besonderen — direkt loslegen.
Einordnung
Geringer Einrichtungsaufwand für eine sichtbar konsistentere Commit-Historie.
Strukturierte Commits mit Conventional-Format und Emoji
Für wen: Saubere Git-Historie
Im Detail
Strukturiert Commit-Messages nach dem Conventional-Commits-Format (type(scope): summary) und ergänzt jeden Typ um ein passendes Emoji, etwa ✨ für feat oder 🐛 für fix, damit sich die Git-Historie beim Scrollen durch git log optisch nach Änderungstyp sortieren lässt. Im Vergleich zu ausführlicheren Formatregeln mit Pflicht-Bullet-Body bleibt commit.mdc kompakter und auf die erste Zeile fokussiert. Geeignet für Teams, die eine lesbare, konsistente Historie wollen, aber keine ausführlichen Commit-Bodies pflegen. Wer automatisiert Changelogs aus Conventional Commits generiert, profitiert zusätzlich von der einheitlichen Struktur.
Schritt für Schritt
- Vor dem ersten Einsatz im Team festlegen, welche Emoji-Zuordnung pro Commit-Typ gelten soll
- Nach einigen Commits git log prüfen, ob Format und Emoji durchgängig konsistent erscheinen
- Bei automatisierter Changelog-Generierung testen, ob das eingesetzte Tooling mit Emojis im Typ-Feld zurechtkommt
- Bei Bedarf eine Konvention für den Scope-Namen (z. B. Modul- oder Feature-Name) im Team abstimmen
Beispiel aus der Praxis
Eine Änderung ergänzt eine neue Exportfunktion. Statt einer freien Beschreibung formuliert die Regel den Commit als „✨ feat(export): CSV-Export ergänzen“, sodass der Typ beim Scrollen durch die Historie sofort optisch erkennbar ist.
Praxis-Tipp
Aktivieren Sie diese Regel projektweit, wenn Sie aus der Commit-Historie automatisiert Changelogs erzeugen – die Emoji sind dafür ignorierbar, das Prefix-Format zählt.
Stolperfallen
Wenn eingesetzte Changelog-Tools Emojis im Commit-Typ nicht korrekt parsen, entstehen unschöne oder fehlerhafte Einträge – das sollte vorher getestet werden. Ohne Absprache im Team über die Scope-Benennung bleibt die Historie trotz Format uneinheitlich.
Siehe auch
Lizenz & Quelle
- Lizenz: MIT
- Quelle: github.com/steipete/agent-rules
Häufige Fragen.
Ist das kompatibel mit bestehenden Conventional-Commits-Setups?
Ja, die Regel baut auf dem type(scope): summary-Format auf und ergänzt es nur um ein passendes Emoji.
Muss ich ausführliche Commit-Bodies schreiben?
Nein, die Regel bleibt bewusst auf die erste Zeile fokussiert und verlangt keinen Pflicht-Bullet-Body.
Was ist der Unterschied zu commit-fast.mdc?
commit-mdc legt den Fokus auf ein konsistentes, emoji-ergänztes Format, während commit-fast.mdc primär Geschwindigkeit priorisiert und den ersten Vorschlag ohne Rückfrage übernimmt.
Inhalt ansehen (commit.mdc)
Lade …
Erfahrungen & Kommentare.
Funktioniert der Rule bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.
Lade Kommentare …
Passt dazu.
v5.md
Basis-Regelwerk: Task-Klassifizierung (leicht/standard/kritisch), Tool-Nutzung, Antwortstil
prompt-injection-guard.md
Schutz vor Prompt-Injection aus externem Kontext (Web/RAG/Dateien): Stopp + Rückfrage bei gefährlichen Aktionen
commit-message-format.md
Commit-Messages nach Conventional Commits (Prefix + Summary + Bullet-Body)
