Skip to content

Commit 80b707b

Browse files
justin808claude
andcommitted
Fix update-changelog command: remove redundancy and fix formatting
Addresses code review feedback: 1. **Removed redundant section headers**: - "New Features" (redundant with standard "Added") - "Bug Fixes" (redundant with standard "Fixed") - "Security Enhancements" (redundant with standard "Security") - "Code Improvements" (internal, not user-visible) 2. **Added "Improved" to standard headers** (used 9 times in CHANGELOG.md) 3. **Emphasized standard headers**: Updated guidance to prefer standard keepachangelog.com headers and use custom ones sparingly 4. **Fixed broken markdown formatting**: - Corrected triple/quadruple backtick issues in Breaking Change example - Removed nested code blocks that broke rendering - Simplified code examples within the markdown example 5. **Final header list**: - Standard: Added, Changed, Deprecated, Removed, Fixed, Security, Improved - Custom: Breaking Changes, API Improvements, Developer Experience, Generator Improvements, Performance, Pro License Features This reduces confusion and ensures the command guides developers to use consistent, standard headers while keeping legitimate project-specific headers for special cases. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent b76c360 commit 80b707b

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed

.claude/commands/update-changelog.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -59,29 +59,26 @@ For breaking changes, use this format:
5959

6060
Entries should be organized under these section headings. The project uses both standard and custom headings:
6161

62-
**Standard headings** (from keepachangelog.com):
62+
**Standard headings** (from keepachangelog.com) - use these for most changes:
6363

6464
- `#### Added` - New features
6565
- `#### Changed` - Changes to existing functionality
6666
- `#### Deprecated` - Deprecation notices
6767
- `#### Removed` - Removed features
6868
- `#### Fixed` - Bug fixes
6969
- `#### Security` - Security-related changes
70+
- `#### Improved` - Improvements to existing features
7071

71-
**Custom headings** (project-specific):
72+
**Custom headings** (project-specific) - use sparingly when standard headings don't fit:
7273

73-
- `#### Breaking Changes` - Breaking changes only
74-
- `#### New Features` - New features
75-
- `#### Bug Fixes` - Bug fixes
76-
- `#### Security Enhancements` - Security improvements
74+
- `#### Breaking Changes` - Breaking changes with migration guides
7775
- `#### API Improvements` - API changes and improvements
78-
- `#### Developer Experience` - DX improvements
79-
- `#### Generator Improvements` - Generator changes
80-
- `#### Code Improvements` - Code quality improvements
76+
- `#### Developer Experience` - Developer workflow improvements
77+
- `#### Generator Improvements` - Generator-specific changes
8178
- `#### Performance` - Performance improvements
82-
- `#### Pro License Features` - Pro-only features
79+
- `#### Pro License Features` - React on Rails Pro features
8380

84-
**Choose the header that best describes your change.** Use custom headers for complex changes that benefit from more specific categorization.
81+
**Prefer standard headings.** Only use custom headings when the change needs more specific categorization.
8582

8683
**Only include section headings that have entries.**
8784

@@ -211,7 +208,7 @@ grep -A 3 "^#### " CHANGELOG.md | head -30
211208

212209
### Breaking Change Example
213210

214-
````markdown
211+
```markdown
215212
- **React on Rails Core Package**: Several Pro-only methods have been removed from the core package and are now exclusively available in the `react-on-rails-pro` package. If you're using any of the following methods, you'll need to migrate to React on Rails Pro:
216213
- `getOrWaitForComponent()`
217214
- `getOrWaitForStore()`
@@ -225,24 +222,14 @@ grep -A 3 "^#### " CHANGELOG.md | head -30
225222
To migrate to React on Rails Pro:
226223

227224
1. Install the Pro package:
228-
229-
```bash
230225
yarn add react-on-rails-pro
231-
# or
232-
npm install react-on-rails-pro
233-
```
234-
````
235226

236227
2. Update your imports from `react-on-rails` to `react-on-rails-pro`:
237-
238-
```javascript
239228
// Before
240229
import ReactOnRails from 'react-on-rails';
241230

242231
// After
243232
import ReactOnRails from 'react-on-rails-pro';
244-
```
245-
246233
```
247234

248235
## Additional Notes
@@ -253,4 +240,3 @@ To migrate to React on Rails Pro:
253240
- Be consistent with existing formatting in the changelog
254241
- Always ensure the file ends with a trailing newline
255242
- See CHANGELOG.md lines 15-18 for additional contributor guidelines
256-
```

0 commit comments

Comments
 (0)