CalvinBackup/gstack
1
0
Fork 0
mirror of https://github.com/garrytan/gstack.git synced 2026-05-13 07:54:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add CHANGELOG integrity check rule

Browse Source 
After any edit that moves/adds/removes entries, grep for version
headers and verify no gaps or duplicates before committing.
Prevents accidentally dropping entries during reordering.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Garry Tan
2026-03-29 22:14:21 -07:00
parent 8758170517
commit 845e1cf35f
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+5
View File
@@ -270,6 +270,11 @@ already landed on main. Your entry goes on top because your branch lands next.
- Is your entry the topmost entry in CHANGELOG (above main's latest)? - Is your entry the topmost entry in CHANGELOG (above main's latest)?
If any answer is no, fix it before continuing. If any answer is no, fix it before continuing.
**After any CHANGELOG edit that moves, adds, or removes entries,** immediately run
`grep "^## \[" CHANGELOG.md` and verify the full version sequence is contiguous
with no gaps or duplicates before committing. If a version is missing, the edit
broke something. Fix it before moving on.
CHANGELOG.md is **for users**, not contributors. Write it like product release notes: CHANGELOG.md is **for users**, not contributors. Write it like product release notes:
- Lead with what the user can now **do** that they couldn't before. Sell the feature. - Lead with what the user can now **do** that they couldn't before. Sell the feature.