Guides changelog writing per Keep a Changelog spec with categories (Added, Changed, Fixed, etc.), imperative mood, user-focused entries, and version sections. Use when updating CHANGELOG.md.
npx claudepluginhub sequenzia/agent-alchemy --plugin agent-alchemy-dev-toolsThis skill uses the workspace's default tool permissions.
This skill provides guidelines for writing and formatting changelogs following the [Keep a Changelog](https://keepachangelog.com/) specification.
Generates changelog entries following Keep a Changelog format by reviewing Git history, classifying changes into Added, Changed, Deprecated, Removed, Fixed, Security categories with user-focused wording.
Generates CHANGELOG.md files in Keep a Changelog format with templates for Added, Changed, Deprecated, Removed, Fixed, and Security sections. Includes guidelines and examples for version history.
Creates and maintains human-readable CHANGELOG.md files for software projects using Keep a Changelog standards. Useful for documenting releases, version history, and changes for users and contributors.
Share bugs, ideas, or general feedback.
This skill provides guidelines for writing and formatting changelogs following the Keep a Changelog specification.
[Unreleased] for upcoming changesUse these categories in this order:
| Category | Description | When to Use |
|---|---|---|
| Added | New features | New functionality users can now do |
| Changed | Changes in existing functionality | Behavior modifications, improvements |
| Deprecated | Soon-to-be removed features | Features marked for future removal |
| Removed | Removed features | Features that no longer exist |
| Fixed | Bug fixes | Corrections to existing functionality |
| Security | Security vulnerability fixes | Security-related changes |
Added
Changed
Deprecated
Removed
Fixed
Security
Start entries with imperative verbs:
| Do | Don't |
|---|---|
| Add support for... | Added support for... |
| Fix crash when... | Fixed a crash that occurred when... |
| Remove deprecated... | Removed the deprecated... |
| Change default to... | Changed the default to... |
Write from the user's perspective:
| Good (User-focused) | Bad (Implementation-focused) |
|---|---|
| Add dark mode toggle | Implement ThemeProvider context |
| Fix login failing silently | Add try-catch to auth handler |
| Speed up page load by 40% | Optimize database queries |
| Good (Specific) | Bad (Vague) |
|---|---|
| Fix crash when uploading files over 10MB | Fix upload bug |
| Add CSV export for transaction history | Add export feature |
| Change session timeout from 30 to 60 minutes | Update session settings |
Use parenthetical context for clarity:
- Add OAuth2 support (Google, GitHub)
- Fix timezone handling (UTC offset calculation)
- Change rate limit (100 → 500 requests/minute)
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).
## [Unreleased]
### Added
- New entries go here
## [1.0.0] - 2024-01-15
### Added
- Initial public release
- Feature A with description
- Feature B with description
### Changed
- Improvement to existing feature
### Fixed
- Bug fix description
## [0.9.0] - 2024-01-01
### Added
- Beta release features
[Unreleased]: https://github.com/owner/repo/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/owner/repo/compare/v0.9.0...v1.0.0
[0.9.0]: https://github.com/owner/repo/releases/tag/v0.9.0
Changelog categories map to version bumps:
| Category | Version Impact |
|---|---|
| Removed (after v1.0) | MAJOR bump |
| Removed (before v1.0) | MINOR bump |
| Added, Changed | MINOR bump |
| Deprecated, Fixed, Security | PATCH bump |
references/entry-examples.md - Examples of well-written vs poorly-written entries