Skip to content

chore: fix contributing changeset advice #4041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
carderne wants to merge 1 commit into from
Closed

chore: fix contributing changeset advice #4041

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Most of the time the changes you'll make are likely to be categorized as patch r

## 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.

@devin-ai-integration devin-ai-integration Bot Jun 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 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.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


Create a markdown file with a descriptive name:

Expand All @@ -286,7 +286,7 @@ The body text (below the frontmatter) is a one-line description of the change. K
|---|---|
| Only packages (`packages/`) | Changeset |
| Only server (`apps/`) | `.server-changes/` file |
| Both packages and server | Just the changeset |
| Both packages and server | Both |

@devin-ai-integration devin-ai-integration Bot Jun 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


See `.server-changes/README.md` for more details.

Expand Down