docs: add changelog rules to prevent modifying released versions

This commit is contained in:
Mario Zechner 2025-12-02 13:15:17 +01:00
parent cd62c87323
commit 4432fc9b72
2 changed files with 9 additions and 2 deletions

View file

@ -38,4 +38,10 @@ When creating issues:
- Keep answers short and concise - Keep answers short and concise
- No emojis in commits, issues, PR comments, or code - No emojis in commits, issues, PR comments, or code
- No fluff or cheerful filler text - No fluff or cheerful filler text
- Technical prose only, be kind but direct (e.g., "Thanks @user" not "Thanks so much @user! 🎉") - Technical prose only, be kind but direct (e.g., "Thanks @user" not "Thanks so much @user!")
## Changelog
- New entries ALWAYS go under `## [Unreleased]` section
- NEVER modify already-released version sections (e.g., `## [0.12.2]`)
- Each version section is immutable once released
- When releasing: rename `[Unreleased]` to the new version, then add a fresh empty `[Unreleased]` section

View file

@ -76,7 +76,8 @@ Complete release process:
```bash ```bash
# Change [Unreleased] to the new version number with today's date # Change [Unreleased] to the new version number with today's date
# e.g., ## [0.7.16] - 2025-11-17 # e.g., ## [0.7.16] - 2025-11-17
# Then add a new empty [Unreleased] section at the top # NEVER add entries to already-released version sections
# Each version section is immutable once released
``` ```
4. **Commit and tag**: 4. **Commit and tag**: