docs: agree on public API changes before implementing them - #4906
Merged
Conversation
Contributor
📝 No Changeset FoundThis PR doesn't include a changeset. A changeset is required to release a new version. How to add a changesetRun this command and follow the prompts: pnpm changesetRemember: Never use |
turnipdabeets
marked this pull request as ready for review
September 10, 2026 21:40
Contributor
Prompt To Fix All With AI### Issue 1
CONTRIBUTING.md:292
**Reference changes are not definitive**
Generated reference files include non-API metadata beyond descriptions, such as each declaration's source `path`. Moving an unchanged declaration between files can therefore satisfy this rule and unnecessarily send contributors through the public API approval workflow. Treat the generated diff as a signal to inspect rather than proof that the API changed.
```suggestion
If `pnpm generate-references` changes anything other than descriptions in a `*-references-latest.json` file, inspect the generated diff to determine whether your change touches public API; these files also contain non-API metadata.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs: point to SDK guidelines and sugges..." | Re-trigger Greptile |
marandaneto
approved these changes
Sep 11, 2026
marandaneto
left a comment
Member
There was a problem hiding this comment.
bot has a comment otherwise lgm
This was referenced Sep 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
On contributor PRs we sometimes only settle the public API after several rounds of implementation review. By then the contributor, or their agent, has built each suggestion along the way, and a late change of direction wastes their work.
Contributors' agents read
AGENTS.mdandCONTRIBUTING.md, but neither says anything about public API.Changes
CONTRIBUTING.md: new "Public API changes" section. Agree on the API shape on the issue before implementing, check existing hooks likebefore_sendfirst, and treat a reviewer's API suggestion as a question rather than an instruction. Agents are told to stop and ask.AGENTS.md: one line pointing agents to that section. It's a pointer rather than a copy, sinceAGENTS.mdasks to keep shared guidance inCONTRIBUTING.md.This PR started as a workflow that labels PRs that change the public API. We dropped it: on fork PRs, CI waits for maintainer approval, so the label would only show up after the first review. The earliest points we can reach are the contributor's agent and the issue, and that's what this covers.
Release info Sub-libraries affected
Libraries affected
None. Docs only.
Checklist
If releasing new changes
pnpm changesetto generate a changeset file🤖 Agent context
Autonomy: Human-driven (agent-assisted)
pull_request_targetworkflow that labels public API changes was built and dry-run against recent PRs, then removed. It only fires once the reference files are committed, which on fork PRs happens after CI is approved, so it can't beat the first review.🤖 Generated with Claude Code
https://claude.ai/code/session_01XxW4HJTg29pzv7iGnVBqwS