Commit 3ead148
Enhance changelog guidelines with comprehensive documentation
Following code review recommendations, this adds:
1. **Section header guidance**: Documents both standard keepachangelog.com
headers (Added, Changed, Deprecated, Removed, Fixed, Security) and
project-specific headers (Breaking Changes, New Features, Bug Fixes,
Security Enhancements, API Improvements, etc.)
2. **Complete format examples**: Three real-world examples showing:
- Simple entry format
- Breaking change with migration guide
- Entry with sub-bullets
All examples verified against actual CHANGELOG.md patterns
3. **Cross-reference**: Added reference to CHANGELOG.md lines 15-18
for contributor guidelines and keepachangelog.com format
4. **Better organization**: Restructured into subsections (Section Headers,
Format Requirements, Entry Format Examples) for easier reference
These enhancements make the guidelines actionable and ensure consistent,
high-quality changelog entries.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>1 parent 4bac8ed commit 3ead148
1 file changed
+45
-6
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| 46 | + | |
| 47 | + | |
46 | 48 | | |
47 | 49 | | |
48 | 50 | | |
49 | 51 | | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
56 | 95 | | |
57 | 96 | | |
58 | 97 | | |
| |||
0 commit comments