Skip to content

Commit 0d87578

Browse files
justin808claude
andauthored
Clarify monorepo changelog structure in documentation (#2055)
## Summary - Add prominent notice about two separate changelogs (open-source and Pro) - Explain when to update which changelog(s) - Clarify version management commands for both changelogs - Restructure section for better readability ## Context This addresses confusion about changelog management in our monorepo. The project already maintains separate changelogs correctly (`/CHANGELOG.md` and `/react_on_rails_pro/CHANGELOG.md`), but the documentation didn't make this clear. ## Changes - Added clear header explaining the two-changelog structure - Provided decision guide for which changelog(s) to update - Updated version management commands to show both paths - Reorganized into clearer subsections ## Test plan - [x] Verify CLAUDE.md formatting is correct - [x] Confirm trailing newline present - [x] Check that git hooks pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent 39267e8 commit 0d87578

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CLAUDE.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,11 +178,24 @@ cd react_on_rails_pro && bundle exec rake rbs:validate
178178
```
179179
## Changelog
180180

181+
**IMPORTANT: This is a monorepo with TWO separate changelogs:**
182+
- **Open Source**: `/CHANGELOG.md` - for react_on_rails gem and npm package
183+
- **Pro**: `/react_on_rails_pro/CHANGELOG.md` - for react_on_rails_pro gem and npm packages
184+
185+
When making changes, update the **appropriate changelog(s)**:
186+
- Open-source features/fixes → Update `/CHANGELOG.md`
187+
- Pro-only features/fixes → Update `/react_on_rails_pro/CHANGELOG.md`
188+
- Changes affecting both → Update **BOTH** changelogs
189+
190+
### Changelog Guidelines
191+
181192
- **Update CHANGELOG.md for user-visible changes only** (features, bug fixes, breaking changes, deprecations, performance improvements)
182193
- **Do NOT add entries for**: linting, formatting, refactoring, tests, or documentation fixes
183194
- **Format**: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)` (no hash in PR number)
184195
- **Use `/update-changelog` command** for guided changelog updates with automatic formatting
185-
- **Version management**: Run `bundle exec rake update_changelog` after releases to update version headers
196+
- **Version management after releases**:
197+
- Open source: `bundle exec rake update_changelog`
198+
- Pro: `cd react_on_rails_pro && bundle exec rake update_changelog`
186199
- **Examples**: Run `grep -A 3 "^#### " CHANGELOG.md | head -30` to see real formatting examples
187200

188201
## ⚠️ FORMATTING RULES

0 commit comments

Comments
 (0)