Skip to content

Commit 9a2bcb9

Browse files
montfortclaude
andauthored
docs: add CHANGELOG.md update to version bump procedures (#41)
Both CLI and Framework release workflows in CLAUDE.md now include updating CHANGELOG.md as a required step, following Keep a Changelog format. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2450596 commit 9a2bcb9

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ Update version references in all docs that mention version numbers:
6767
- `README.md` (versioning table)
6868
- `docs/i18n/es/README.md` (ES — versioning table)
6969

70+
Update `CHANGELOG.md` (root) following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format:
71+
- Add a new `## CLI X.Y.Z` section at the top (below the header)
72+
- Use subsections: `### Added (CLI)`, `### Changed (CLI)`, `### Fixed (CLI)`, `### Removed` as applicable
73+
- Describe user-facing changes concisely
74+
7075
### Step 2: Commit and merge
7176

7277
```bash
@@ -129,6 +134,11 @@ Update version references in docs:
129134
- `dist/.devtrail/00-governance/DOCUMENTATION-POLICY.md` (EN + ES footer)
130135
- `dist/.devtrail/00-governance/C4-DIAGRAM-GUIDE.md` (EN + ES footer)
131136

137+
Update `CHANGELOG.md` (root) following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format:
138+
- Add a new `## Framework X.Y.Z` section at the top (below the header)
139+
- Use subsections: `### Added (Framework)`, `### Changed (Framework)`, `### Fixed`, `### Removed` as applicable
140+
- If both CLI and Framework are bumped together, combine into `## Framework X.Y.Z / CLI X.Y.Z`
141+
132142
### Step 2: Commit and merge
133143

134144
```bash

0 commit comments

Comments
 (0)