@@ -17,17 +17,18 @@ This file provides guidance to Claude Code when working with this repository.
1717
1818## Release Notes Workflow
1919
20- ** IMPORTANT** : Do NOT add new version headers (` ## v1.0.x ` ) to RELEASE_NOTES.md manually.
20+ ** IMPORTANT** : Do NOT add new version headers (` ## v1.0.x ` ) to RELEASE_NOTES.md manually. The CI workflow adds them automatically.
2121
22- The release workflow (` .github/workflows/release.yml ` ) handles versioning:
23- 1 . ` npm version patch ` bumps the version (e.g., 1.0.2 → 1.0.3)
24- 2 . The script automatically inserts the NEXT version header (` ## 1.0.4 ` ) at the top as a placeholder
22+ ** How it works** :
23+ 1 . After releasing v1.0.2, the CI adds ` ## v1.0.3 ` as a placeholder for the next release
24+ 2 . Developers add their changes UNDER the existing ` ## v1.0.3 ` section
25+ 3 . When releasing v1.0.3, the CI adds ` ## v1.0.4 ` as the new placeholder
2526
26- ** During development** : Add changes under the existing version section at the top (the one created by the previous release workflow ):
27+ ** During development** : Add changes under the existing version placeholder (already created by CI ):
2728``` markdown
2829# Release Notes
2930
30- ## v1.0.3 <-- placeholder added by workflow , add your changes here
31+ ## v1.0.3 <-- placeholder added by CI after 1.0.2 release , add your changes here
3132
3233### Features
3334- New feature description
@@ -40,7 +41,7 @@ The release workflow (`.github/workflows/release.yml`) handles versioning:
4041## v1.0.2 <-- previous release (do not modify)
4142```
4243
43- When releasing v1.0.3, the workflow will add ` ## v1.0.4 ` as the new placeholder for future changes .
44+ ** Never remove the version placeholder ** - it was added by CI after the previous release .
4445
4546## Project Overview
4647
0 commit comments