Repository navigation
Make Open PR Board suggested comments ready to post - #6163
Conversation
Separate public suggested comments from internal maintainer advice across review prompts and action schema. Document the contract and cover initial reviews, re-reviews, and empty comments. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
🚦 Submission status: 👀 Ready for reviewRisk tier: Why this tier
Automated checks
Review
Commands
Updated for |
|
🟡 Contributor Reputation Check: MEDIUM risk
Maintainers: please review this contributor before merging. |
There was a problem hiding this comment.
🔵 Needs a closer look
Maintainer review is needed to confirm the board instructions and public wording proposed under their identity, since validation covers prompt/schema contracts but not live Copilot output.
No open issues 🎉
What changed in this PR
This PR updates Open PR Board’s review guidance so suggested comments address PR authors directly and keep maintainer-only advice in internal fields.
Changes:
- Shares a public-comment contract across initial reviews, re-reviews, and the
record_reviewschema. - Documents post-ready wording, preserved uncertainty, and optional empty comments, with examples.
- Adds regression checks for prompt and schema requirements; model-output quality remains unevaluated.
| File | Description |
|---|---|
eng/open-pr-board.test.mjs |
Checks the shared comment contract and optional-comment behavior. |
.github/extensions/open-pr-board/review-guidance.md |
Separates public feedback from internal advice and adds examples. |
.github/extensions/open-pr-board/README.md |
Documents comment expectations and regeneration of stored suggestions. |
.github/extensions/open-pr-board/lib/review-prompt.mjs |
Applies shared public-comment guidance to prompts and schema descriptions. |
Review effort: Balanced (auto)
| ].join("\n"); | ||
|
|
||
| const PUBLIC_COMMENT_GUIDE = [ | ||
| "`suggestedComment` is public text ready to post verbatim as the maintainer addressing the PR author directly, in a natural maintainer voice, not an agent report to the maintainer.", |
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
Open PR Board suggestions can currently address the maintainer instead of the PR author, making direct posting confusing. This change explicitly separates public feedback from internal review advice.
A shared public-comment contract now applies to initial review prompts, re-review prompts, and the
record_reviewaction schema. It requires natural maintainer-to-author wording, concrete evidence, actionable changes or an evidence-backed decision, and preserved uncertainty. Maintainer instructions, board terminology, and invented claims of completed GitHub actions stay out of public comments; internal advice remains in fields such asrationale,risks, andcheckNext.The existing omitted/empty-comment convention remains intact. Review guidance includes examples, and regression coverage checks each prompt surface, including reviews with calibration and prior guidance.
Type of Contribution
Additional Notes
Validation:
node --test eng\open-pr-board.test.mjs eng\board-bulk-actions.test.mjspassed: 77 tests, 0 failures, 0 skipped. GitHub actions are exercised with in-process fakes.npm startpassed afternpm cirestored missing dependencies; generated tracked outputs were unchanged. The build reported existing external-plugin SPDX warnings.bash eng/fix-line-endings.shpassed.git --no-pager diff --checkpassed.No live Copilot generation was evaluated: the tests verify prompt/schema contracts, not model-output quality. Existing stored suggestions are not rewritten; re-review a PR to regenerate them. No PR comments or reviews were posted during implementation.
The paid-services and new-file checklist items do not apply. Dependency restoration reported 4 audit findings (1 moderate, 3 high); dependency changes are outside this PR's scope.
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.