docs: strengthen tree API report guidance to prevent spurious diffs#27052
Merged
noencke merged 4 commits intomicrosoft:mainfrom Apr 20, 2026
Merged
docs: strengthen tree API report guidance to prevent spurious diffs#27052noencke merged 4 commits intomicrosoft:mainfrom
noencke merged 4 commits intomicrosoft:mainfrom
Conversation
The existing docs recommended per-package clean builds to fix unexpected API report diffs in the tree package, but this is unreliable due to an incremental TypeScript bug that leaves stale artifacts in dependency packages. Update all relevant docs to prescribe a full root-level `pnpm clean && pnpm build` as the only reliable fix. Changes: - CLAUDE.md / copilot-instructions.md: add short "never hand-edit api.md" rule with pointer to tree-api-checks.md - tree-api-checks.md: rewrite phantom-diff section with explicit "golden rule", anti-pattern list, and full root clean commands; remove incorrect azure-client references; remove redundant cascade section (full build already covers aggregators) - ci-readiness-check SKILL.md: distinguish tree (needs root clean) from other packages (scoped clean OK); add never-hand-edit warning Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add guidance for agents to inform the user when and why they're doing a full clean build, since it takes several minutes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The agent doesn't have write access to upstream PRs. Add instructions to write the updated description to a temp file and tell the user to copy-paste it into GitHub. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates internal contributor/agent documentation to reduce spurious @fluidframework/tree API report diffs by steering folks toward reliable “full clean build” workflows and away from hand-editing generated artifacts.
Changes:
- Adds “never hand-edit
*.api.md” guidance and pointers to tree-specific API diff troubleshooting docs. - Reworks tree API diff troubleshooting instructions to emphasize root-level
pnpm clean && pnpm buildover scoped cleans. - Updates CI readiness-check guidance to reflect the tree/aggregator incremental TypeScript nondeterminism behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/copilot-instructions.md | Adds API report “generated artifact” rule + pointer to tree API checks doc. |
| .claude/CLAUDE.md | Mirrors the API report guidance for Claude instructions. |
| .claude/skills/ci-readiness-check/tree-api-checks.md | Reframes tree-specific API report troubleshooting around full clean builds and examples. |
| .claude/skills/ci-readiness-check/SKILL.md | Updates readiness-check workflow to prefer root clean/build for tree-related API diffs. |
| .claude/skills/fluid-pr/SKILL.md | Documents how to provide updated PR body text via a temp file for manual copy/paste. |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Josmithr
approved these changes
Apr 20, 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.
Description
Strengthens documentation around handling unexpected API report diffs in
@fluidframework/tree. The existing docs recommended per-package clean builds, but these are unreliable due to an incremental TypeScript bug that leaves stale artifacts in dependency packages. All relevant docs now prescribe a full root-levelpnpm clean && pnpm buildas the only reliable fix.Also adds a note to the
fluid-prskill about the workaround for editing existing PR descriptions (write to a temp file for the user to copy-paste, since the agent lacks upstream write access).Changes:
tree-api-checks.mdazure-clientreferences and redundant cascade section (full build already covers aggregators).Reviewer Guidance
The review process is outlined on this wiki page.
Documentation-only change — no functional code affected.