tuyv Changelog Writing Style
Format
Based on Keep a Changelog.
Entry Structure
## [X.Y.Z] - YYYY-MM-DD
### Added/Changed/Fixed/Removed
- **`item-name`** - Description of change
- Sub-bullet for additional details
- Another detail if needed
Rules
- Bold item names - Always wrap in
**\item-name`**` (backticks inside bold) - Dash separator - Use
-between item name and description - Sentence case - Descriptions start with capital letter
- No periods - End descriptions without periods
- Sub-bullets - Indent with 2 spaces, use for details
Section Order
- Added
- Changed
- Fixed
- Removed
Only include sections with content.
Examples
Good:
- **`debug plugin`** - Renamed skill: systematic-debugging → debug
- **`/workflows:plan` command** - Interactive Q&A refinement phase (#88)
- After generating initial plan, now offers to refine with targeted questions
- Asks up to 5 questions about ambiguous requirements
Bad:
- debug plugin - renamed skill # missing bold/backticks
- **debug plugin**: renamed skill # colon instead of dash
- **`debug plugin`** - renamed skill. # has period
Versioning
- Major (X.0.0) - Breaking changes, major removals
- Minor (X.Y.0) - New features, new plugins
- Patch (X.Y.Z) - Bug fixes, renames, documentation