Help update the CHANGELOG.md file with new entries:
Workflow
- •
Read the current CHANGELOG.md:
bashcat /Users/bri/dev/Trebuchet/CHANGELOG.md | head -50
- •
Show the last release tag:
bashcd /Users/bri/dev/Trebuchet && git describe --tags --abbrev=0 2>/dev/null || echo "No tags yet"
- •
Get unreleased commits:
bashcd /Users/bri/dev/Trebuchet && git log $(git describe --tags --abbrev=0 2>/dev/null || git rev-list --max-parents=0 HEAD)..HEAD --oneline --no-merges
- •
For each significant commit, ask the user to categorize:
- •Added: New features
- •Changed: Changes to existing functionality
- •Deprecated: Soon-to-be removed features
- •Removed: Removed features
- •Fixed: Bug fixes
- •Security: Security fixes
- •
Ask the user for user-friendly descriptions of each change
- •
Update CHANGELOG.md with new entries under
[Unreleased]section - •
Ask: "Do you want to prepare this for a release?"
- •If yes: Create new version section with today's date, move entries from [Unreleased]
- •If no: Leave entries under [Unreleased]
Format
Follow the Keep a Changelog standard:
markdown
## [Unreleased] ### Added - New feature description ### Fixed - Bug fix description ## [0.4.0] - 2025-01-15 ### Added - Previous features
Guidelines
- •Use present tense ("Add feature" not "Added feature")
- •Focus on user impact, not implementation details
- •Keep entries concise but meaningful
- •Link to issues/PRs when applicable