docs(#4777): add API surface review guidance - #4778
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a Review guidance for public API changes section to the scorecard AGENTS.md after the existing threshold review guidance. The new section instructs the review agent to: (1) verify new public type exports from scorecard-common or scorecard-node have production consumers, (2) flag test-only exports as [medium] and suggest local type aliases, and (3) verify changeset bump level when an author broadens usage to justify the export. This addresses a gap where the review agent missed an API surface concern that a human reviewer caught on PR #4602. Closes #4777
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4778 +/- ##
=======================================
Coverage 63.02% 63.02%
=======================================
Files 2642 2642
Lines 105660 105660
Branches 29581 29581
=======================================
Hits 66587 66587
Misses 38529 38529
Partials 544 544
*This pull request uses carry forward flags. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
|
🤖 Review · Commit: |
|
🤖 Finished Review · ✅ Success · Started 4:20 PM UTC · Completed 4:25 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Cost: $0.58 |
Review — ApproveScope: Documentation-only change — 1 file, +22 lines SummaryThis PR adds a "Review guidance for public API changes" section to the scorecard workspace What was reviewed
VerdictClean documentation change that addresses a concrete retro finding. No findings to report. Labels: Documentation-only change adding review guidance to scorecard AGENTS.md |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
fullsend-ai-review
Bot
added
ready-for-merge
Add a Review guidance for public API changes section to the scorecard AGENTS.md after the existing threshold review guidance. The new section instructs the review agent to: (1) verify new public type exports from scorecard-common or scorecard-node have production consumers, (2) flag test-only exports as [medium] and suggest local type aliases, and (3) verify changeset bump level when an author broadens usage to justify the export.
This addresses a gap where the review agent missed an API surface concern that a human reviewer caught on PR #4602.
Closes #4777
Post-script verification
agent/4777-api-surface-review-guidance)47ac76dcd418a4003112ccb0032f2274cd46d420..HEAD)