| name | changelog |
| description | Skill for maintaining CHANGELOG.md |
Changelog Skill
CHANGELOG Format
Follow Keep a Changelog:
# Changelog
## [Unreleased]
### Added
- New feature X
### Changed
- Modified behavior Y
### Fixed
- Bug fix Z
## [1.2.0] - 2024-01-15
### Added
- Feature A
Categories
| Category | Use For |
|---|
Added | New features |
Changed | Modified behavior |
Deprecated | Soon-to-be removed |
Removed | Removed features |
Fixed | Bug fixes |
Security | Security fixes |
Entry Style
Good Entry
- Add OAuth2 authentication support (#42)
Bad Entry
- Fixed stuff
- Updated code
Process
- Read PR description from SENTINEL's final-review.md
- Categorize changes
- Write concise, user-focused entry
- Place under
[Unreleased] section
- Commit with message:
docs: update CHANGELOG for T-{id}
Release
When version is released:
- Rename
[Unreleased] to [version] - date
- Add new
[Unreleased] section
- Tag release in git