add-to-changelog.mdc

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

Für wen: Release-Manager

Im Detail

Eine Regel für IDE-Agents, die automatisch dafür sorgt, dass Änderungen im CHANGELOG.md nach dem etablierten „Keep a Changelog“-Format dokumentiert werden, statt dass diese Pflege vergessen oder inkonsistent gehandhabt wird. Sie stammt aus der repository-übergreifenden Sammlung steipete/agent-rules und lässt sich in verschiedenen IDEs mit KI-Unterstützung einbinden. Sinnvoll für Release-Manager und Maintainer von Open-Source- oder Team-Projekten, die Wert auf nachvollziehbare, standardisierte Versionshistorien legen, ohne die Formatierung jedes Mal manuell nachzuschlagen. Wer kein striktes Changelog-Format pflegt oder Commits als alleinige Historie nutzt, braucht diese Regel nicht zwingend.

Beispiel aus der Praxis

Nach dem Merge eines Bugfix-Pull-Requests lässt man add-to-changelog.mdc laufen; der Agent trägt die Änderung automatisch unter der passenden Kategorie wie „Fixed“ im CHANGELOG.md ein, sodass die Versionshistorie ohne manuellen Zusatzschritt konsistent bleibt.

Praxis-Tipp

Aktivieren Sie die Regel projektweit, damit der Agent nach jeder abgeschlossenen Änderung automatisch einen passenden Eintrag unter „Unreleased“ im CHANGELOG.md ergänzt.

Stolperfallen

Wer Commits als alleinige Historie nutzt oder kein striktes Changelog-Format pflegt, braucht die Regel laut Quelle nicht zwingend - ohne konsequente Nutzung verwässert die Historie schnell wieder.

Siehe auch

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

Lizenz & Quelle

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