Skip to content

Commit 3ead148

Browse files
justin808claude
andcommitted
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

File tree

1 file changed

+45
-6
lines changed

1 file changed

+45
-6
lines changed

CLAUDE.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,55 @@ Git hooks will automatically run linting on **all changed files (staged + unstag
4343

4444
## Changelog
4545

46+
**See CHANGELOG.md lines 15-18 for contributor guidelines and [keepachangelog.com](http://keepachangelog.com/) format.**
47+
4648
- **Update CHANGELOG.md for user-visible changes only**
4749
- User-visible changes include: new features, bug fixes, breaking changes, deprecations, performance improvements
4850
- **Do NOT add changelog entries for**: linting fixes, code formatting, internal refactoring, test updates, documentation fixes
4951
- Non-user-visible changes don't need changelog entries even if they modify code
50-
- **Format requirements**:
51-
- Always link to the PR: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818)` (no hash symbol)
52-
- Always link to the author: `by [username](https://github.com/username)`
53-
- Keep formatting consistent with existing entries
54-
- When releasing a version, run `bundle exec rake update_changelog` to update version headers and diff links
55-
- **For breaking changes**: Use bold formatting and link to migration documentation (e.g., `**Breaking**: Description. See [Migration Guide](docs/vX_upgrade.md)`)
52+
53+
### Section Headers
54+
55+
Use appropriate section headers under the `[Unreleased]` version:
56+
57+
- **Standard headers** (from keepachangelog.com): `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`
58+
- **Custom headers** (project-specific): `New Features`, `Breaking Changes`, `Bug Fixes`, `Security Enhancements`, `API Improvements`, `Developer Experience`, `Generator Improvements`, `Code Improvements`, `Performance`, `Pro License Features`
59+
60+
Choose the header that best describes your change. Use custom headers for complex changes that benefit from more specific categorization.
61+
62+
### Format Requirements
63+
64+
- **PR link format**: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818)` (no hash symbol)
65+
- **Author link format**: `by [username](https://github.com/username)`
66+
- Keep formatting consistent with existing entries
67+
- When releasing a version, run `bundle exec rake update_changelog` to update version headers and diff links
68+
69+
### Entry Format Examples
70+
71+
**Simple entry:**
72+
73+
```markdown
74+
- **Feature Name**: Brief description of the change. [PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)
75+
```
76+
77+
**Breaking change with migration guide:**
78+
79+
```markdown
80+
- **Feature Name**: Description of breaking change. See migration guide below. [PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)
81+
82+
**Migration Guide:**
83+
84+
1. Step one
85+
2. Step two
86+
```
87+
88+
**Entry with sub-bullets:**
89+
90+
```markdown
91+
- **Feature Name**: Description with details:
92+
- Detail one with more context
93+
- Detail two. [PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)
94+
```
5695

5796
## ⚠️ FORMATTING RULES
5897

0 commit comments

Comments
 (0)