| name | update-changelog |
| description | Read this skill before updating changelogs |
Update the repository changelog with changes between the last release and the current version (main) that are not yet incorporated. If CHANGELOG.md does not exist, use CHANGELOG instead.
Step-by-Step Process
1. Determine baseline version
If no baseline version is provided, use the most recent git tag. You can find it with git describe --tags --abbrev=0.
2. Find the commits from git
Use the following commands to gather commit information:
git describe --tags --abbrev=0
git log <baseline-version>..HEAD
3. Update the changelog
Read the existing changelog file (CHANGELOG.md, or CHANGELOG if missing) and check if there are changes not yet incorporated, then add them. Always add them to the "Unreleased" section only. If there is none yet, add it at the top in the same style as the existing changelog (for example, ## Unreleased vs ## [Unreleased]).
Ground Rules When Writing Changelogs
Content Guidelines
- Focus on notable changes that affect users (features, fixes, breaking changes)
- Mention pull requests (
#NUMBER) when available, but not raw commit hashes
- Ignore insignificant changes (typo fixes, internal refactoring, minor documentation updates)
- Group related changes together when appropriate
- Order entries by importance: breaking changes first, then features, then fixes
Style Guidelines