add-to-changelog.mdc

Pflegt CHANGELOG.md nach „Keep a Changelog“-Standard

Für wen: Release-Manager

Im Detail

Diese Regel automatisiert das lästige, aber wichtige Nachpflegen von CHANGELOG.md nach dem „Keep a Changelog“-Format mit Kategorien wie Added, Changed und Fixed samt Versions- und Datumsangaben. Statt am Ende eines Release-Zyklus mühsam aus der Commit-Historie zu rekonstruieren, was sich geändert hat, trägt die Regel Änderungen direkt beim Commit oder PR ein. Für Projekte ohne strikte Commit-Message-Konventionen ist das zuverlässiger als automatisch aus dem Git-Log generierte Changelogs. Release-Manager und Maintainer von Open-Source-Projekten profitieren am meisten; für rein interne Tools ohne externe Nutzer ist der Aufwand oft nicht nötig.

Voraussetzungen

• Bestehende CHANGELOG.md nach dem „Keep a Changelog“-Format
• IDE bzw. Editor mit Unterstützung für diese Regel

Schritt für Schritt

1. Regel im Projekt aktivieren, damit sie bei Commits oder Pull Requests greift
2. Bei jedem Commit/PR prüfen, ob der Eintrag in der richtigen Kategorie (Added, Changed, Fixed) landet
3. Versions- und Datumsangaben beim Release ergänzen oder kontrollieren
4. Bei Projekten ohne feste Commit-Message-Konventionen besonders genau auf korrekte Einträge achten
5. Changelog vor jedem Release noch einmal durchsehen

Beispiel aus der Praxis

Ein Feature-Branch mit einer neuen PDF-Exportfunktion wird gemergt. Die Regel trägt dazu automatisch einen Eintrag „Added: PDF-Export“ unter „Unreleased“ in die CHANGELOG.md ein.

Praxis-Tipp

Kombinieren Sie diese Regel mit commit-message-format.md, damit Commit-Texte gleich so geschrieben werden, dass sie sich fast unverändert ins Changelog übernehmen lassen.

Stolperfallen

Für rein interne Tools ohne externe Nutzer lohnt sich der Pflegeaufwand oft nicht. Die Regel sorgt nur dafür, dass überhaupt ein Eintrag entsteht – ob er verständlich formuliert ist, muss weiterhin manuell geprüft werden.

Siehe auch

• commit-message-format.md
• pr-message-format.md

Lizenz & Quelle

• Lizenz: MIT
• Quelle: github.com/steipete/agent-rules

Lade …