chore: fix contributing changeset advice#4041
Conversation
|
|
Thanks for your contribution! We require all external PRs to be opened in draft status first so you can address CodeRabbit review comments and ensure CI passes before requesting a review. Please re-open this PR as a draft. See CONTRIBUTING.md for details. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| | Only packages (`packages/`) | Changeset | | ||
| | Only server (`apps/`) | `.server-changes/` file | | ||
| | Both packages and server | Just the changeset | | ||
| | Both packages and server | Both | |
There was a problem hiding this comment.
🟡 Contradictory contributor guidance for mixed-change PRs across documentation files
The updated guidance now tells contributors with both package and server changes to add "Both" a changeset and a server-changes file (CONTRIBUTING.md:289), but two related docs still say the opposite, so contributors following the README or agent instructions will skip the server-changes file.
Impact: Contributors reading .server-changes/README.md or CLAUDE.md will follow the old, now-incorrect instructions and omit server-change files for mixed PRs.
Inconsistent documentation sites that were not updated
.server-changes/README.md:9 still reads: "Mixed PRs (both packages and server): Just add a changeset as usual. No .server-changes/ file needed — the changeset covers it."
CLAUDE.md:95 still reads: "When modifying only server components (apps/webapp/, apps/supervisor/, etc.) with no package changes, add a .server-changes/ file instead."
Both directly contradict the new CONTRIBUTING.md guidance that mixed PRs should add both a changeset and a .server-changes/ file.
Prompt for agents
The PR updated CONTRIBUTING.md to say mixed PRs (both packages and server changes) should add both a changeset and a .server-changes/ file. However, two other documentation files still contain the old contradictory guidance:
1. .server-changes/README.md line 9 says: Mixed PRs (both packages and server): Just add a changeset as usual. No .server-changes/ file needed — the changeset covers it. This needs to be updated to say both are needed.
2. CLAUDE.md line 95 says: When modifying only server components (apps/webapp/, apps/supervisor/, etc.) with no package changes, add a .server-changes/ file instead. The words 'only' and 'with no package changes' and 'instead' should be removed/adjusted to match the new policy that server-changes files should be added whenever server components change, regardless of whether packages also change.
Update both files to be consistent with the new CONTRIBUTING.md guidance.
Was this helpful? React with 👍 or 👎 to provide feedback.
| ## Adding server changes | ||
|
|
||
| Changesets only track published npm packages. If your PR only changes server components (`apps/webapp/`, `apps/supervisor/`, `apps/coordinator/`, etc.) with no package changes, add a `.server-changes/` file so the change appears in release notes. | ||
| Changesets only track published npm packages. If your PR changes server components (`apps/webapp/`, `apps/supervisor/`, `apps/coordinator/`, etc.), add a `.server-changes/` file so the change appears in release notes. |
There was a problem hiding this comment.
🚩 Policy change broadens when .server-changes files are required
The two edits work together to change the contribution policy: line 262 removes the word "only" so that .server-changes/ files are now required whenever server components change (not just for server-only PRs), and line 289 changes the table entry for mixed PRs from "Just the changeset" to "Both". This is a deliberate policy broadening. The consequence is that mixed PRs will now generate two changelog artifacts (a changeset for package release notes and a .server-changes/ file for server release notes), which may result in duplicate entries in release notes if the release tooling doesn't deduplicate. Worth confirming the release automation handles this gracefully.
Was this helpful? React with 👍 or 👎 to provide feedback.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
Walkthrough
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Thanks for your contribution! We require all external PRs to be opened in draft status first so you can address CodeRabbit review comments and ensure CI passes before requesting a review. Please re-open this PR as a draft. See CONTRIBUTING.md for details. |
1 participant
Apparently existing advice is wrong