|
| 1 | +# Changelog Conventions |
| 2 | + |
| 3 | +Context CLI follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format for documenting notable changes. |
| 4 | + |
| 5 | +## Format |
| 6 | + |
| 7 | +Each release entry follows this structure: |
| 8 | + |
| 9 | +```markdown |
| 10 | +## [X.Y.Z] - YYYY-MM-DD |
| 11 | + |
| 12 | +### Added |
| 13 | +- New features |
| 14 | + |
| 15 | +### Changed |
| 16 | +- Changes to existing functionality |
| 17 | + |
| 18 | +### Deprecated |
| 19 | +- Features that will be removed in future versions |
| 20 | + |
| 21 | +### Removed |
| 22 | +- Features that were removed |
| 23 | + |
| 24 | +### Fixed |
| 25 | +- Bug fixes |
| 26 | + |
| 27 | +### Security |
| 28 | +- Vulnerability fixes |
| 29 | +``` |
| 30 | + |
| 31 | +## Categories |
| 32 | + |
| 33 | +Use these categories in the order listed: |
| 34 | + |
| 35 | +| Category | When to use | |
| 36 | +|---|---| |
| 37 | +| **Added** | New features, new CLI commands, new checks, new output formats | |
| 38 | +| **Changed** | Changes to existing behavior, scoring weight adjustments, API changes | |
| 39 | +| **Deprecated** | Features marked for future removal | |
| 40 | +| **Removed** | Features that have been removed | |
| 41 | +| **Fixed** | Bug fixes, corrected scoring, fixed edge cases | |
| 42 | +| **Security** | Vulnerability patches, dependency updates for security | |
| 43 | + |
| 44 | +## Guidelines |
| 45 | + |
| 46 | +- Write entries from the user's perspective, not the developer's |
| 47 | +- Start each entry with a verb (Add, Fix, Change, Remove, etc.) |
| 48 | +- Reference issue numbers where applicable |
| 49 | +- Group related changes into a single entry when they form a logical unit |
| 50 | +- Keep entries concise but descriptive enough to understand without reading the code |
| 51 | +- Unreleased changes go under an `## [Unreleased]` section at the top |
| 52 | + |
| 53 | +## Version Links |
| 54 | + |
| 55 | +At the bottom of `CHANGELOG.md`, include comparison links: |
| 56 | + |
| 57 | +```markdown |
| 58 | +[Unreleased]: https://github.com/hanselhansel/context-cli/compare/v3.0.0...HEAD |
| 59 | +[3.0.0]: https://github.com/hanselhansel/context-cli/compare/v2.0.0...v3.0.0 |
| 60 | +[2.0.0]: https://github.com/hanselhansel/context-cli/releases/tag/v2.0.0 |
| 61 | +``` |
| 62 | + |
| 63 | +## Versioning |
| 64 | + |
| 65 | +Context CLI follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html): |
| 66 | + |
| 67 | +- **Major** (X.0.0) -- breaking changes to CLI interface, scoring model changes, API changes |
| 68 | +- **Minor** (0.Y.0) -- new features, new commands, new checks |
| 69 | +- **Patch** (0.0.Z) -- bug fixes, documentation updates, dependency updates |
0 commit comments