Skip to content

Commit 8521fba

Browse files
justin808claude
andcommitted
Fix CONTRIBUTING.md and clarify workspace dependency guidance
Documentation fixes addressing Phase 6 restructuring feedback: 1. Fix Pro gem path in CONTRIBUTING.md (line 79): - WAS: path: "<React on Rails root>/react_on_rails_pro" - NOW: path: "<React on Rails root>" - After Phase 6, Pro gemspec is at repository root 2. Clarify workspace dependency behavior in testing-build-scripts.md: - Added note explaining yarn.lock behavior with "*" dependencies - Clarified that seeing [email protected] in yarn.lock is normal - Yarn still hoists workspace packages correctly despite cached version Testing completed: ✅ gem build react_on_rails.gemspec - SUCCESS ✅ gem build react_on_rails_pro.gemspec - SUCCESS ✅ rake release[16.2.0.beta.13,true] - SUCCESS (paths all correct) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent d43d32a commit 8521fba

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.claude/docs/testing-build-scripts.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,13 @@ For Yarn Classic workspaces:
137137
In Yarn Classic workspaces:
138138

139139
- `"*"` tells Yarn to resolve to the local workspace package
140-
- Yarn automatically links to the workspace version
140+
- Yarn automatically hoists the workspace package to root node_modules
141141
- This is the official Yarn v1 workspace syntax
142142

143+
**Note:** You may see `react-on-rails@*` with a version like `16.1.2` in yarn.lock.
144+
This is normal - Yarn caches the resolution, but still uses workspace hoisting at
145+
install time. The workspace package won't have its own node_modules subfolder.
146+
143147
### Testing Workspace Changes
144148

145149
When modifying workspace dependencies in package.json:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ gem "react_on_rails", path: "<React on Rails root>"
7676
and/or
7777

7878
```ruby
79-
gem "react_on_rails_pro", path: "<React on Rails root>/react_on_rails_pro"
79+
gem "react_on_rails_pro", path: "<React on Rails root>"
8080
```
8181

8282
Note that you will need to run `bundle install` after making this change, but also that **you will need to restart your Rails application if you make any changes to the gem**.

0 commit comments

Comments
 (0)