Commit 9fb9681
Enhance changelog documentation with react_on_rails improvements (#801)
## Summary
Following [react_on_rails PR
#1867](shakacode/react_on_rails#1867), this
enhances the changelog documentation in both the `/update-changelog`
command and `CLAUDE.md`.
## Changes
### `/update-changelog` command enhancements:
- **Version management section added** with `bundle exec rake
update_changelog` reference
- **Enhanced category organization** distinguishing standard
(keepachangelog.com) vs custom headings
- **Real examples command** added: `grep -A 3 "^### " CHANGELOG.md |
head -30`
- **Additional entry examples** including sub-bullets format
- **Format clarification** noting Shakapacker uses `#` in PR links
unlike React on Rails
### `CLAUDE.md` improvements:
- **Streamlined changelog section** with more concise bullet points
- **Added slash command reference** pointing to `/update-changelog` for
guided updates
- **Added version management** with rake task reference
- **Added examples command** for viewing real formatting
- **Clarified PR format** noting Shakapacker uses `#` in links
## Impact
This ensures consistent, high-quality changelog maintenance across the
project, making it easier for contributors to understand changelog
requirements and formatting.
## Comparison with React on Rails
The main difference preserved is the PR link format:
- React on Rails uses: `[PR 1867]` (no hash)
- Shakapacker uses: `[PR #1867]` (with hash)
All other improvements from the react_on_rails PR have been adapted for
Shakapacker.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude <[email protected]>1 parent afcad76 commit 9fb9681
2 files changed
+52
-21
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
| 54 | + | |
55 | 55 | | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
64 | 74 | | |
65 | 75 | | |
66 | 76 | | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
67 | 90 | | |
68 | 91 | | |
69 | 92 | | |
| |||
114 | 137 | | |
115 | 138 | | |
116 | 139 | | |
117 | | - | |
| 140 | + | |
118 | 141 | | |
119 | 142 | | |
120 | 143 | | |
| |||
165 | 188 | | |
166 | 189 | | |
167 | 190 | | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
168 | 197 | | |
169 | 198 | | |
170 | 199 | | |
| |||
174 | 203 | | |
175 | 204 | | |
176 | 205 | | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
177 | 212 | | |
178 | 213 | | |
179 | 214 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
42 | 38 | | |
43 | 39 | | |
44 | 40 | | |
| |||
0 commit comments