Repository navigation
Fix frontmatter quote-style guidance in PR reviews - #5605
Conversation
Remove outdated single-quote requirements from repository review guidance and Open PR Board prompts. Apply Agent Skills spec constraints without imposing a quote style, and cover both review paths and YAML parsing. 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
Changes to repository-wide review policy require maintainer sign-off.
No open issues 🎉
What changed in this PR
Corrects frontmatter guidance so repository reviews accept valid YAML scalar styles without relaxing metadata requirements. Executable validation remains unchanged.
Changes:
- Removes single-quote requirements from contributor guidance and Learning Hub documentation.
- Clarifies Agent Skills field constraints and applies the guidance to initial-review and re-review briefs.
- Adds regression tests for generated prompts, five scalar styles, malformed YAML, and missing required metadata.
| File | Description |
|---|---|
website/src/content/docs/learning-hub/creating-effective-skills.md |
Documents quote-style flexibility for skill descriptions. |
eng/yaml-parser.test.mjs |
Tests scalar styles and invalid or incomplete frontmatter. |
eng/open-pr-board.test.mjs |
Checks frontmatter guidance in both review briefs. |
AGENTS.md |
Removes single-quote requirements from contributor checklists. |
.github/skills/code-review/SKILL.md |
Clarifies scalar-style acceptance and skill field constraints. |
.github/extensions/open-pr-board/review-guidance.md |
Updates board review procedures for frontmatter and skills. |
.github/extensions/open-pr-board/lib/review-prompt.mjs |
Adds corrected guidance to shared review-prompt rules. |
.github/copilot-instructions.md |
Updates frontmatter policy and skill metadata checks. |
Review effort: Max
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
Open PR Board reviews were requesting single-quoted YAML frontmatter because repository guidance still required it. Remove that outdated requirement from the repository's contributor/reviewer guidance and Learning Hub documentation, and explicitly carry the correction into both initial-review and re-review agent briefs.
Accept valid plain, single-quoted, double-quoted, literal, and folded scalars while preserving required metadata fields, types, lengths, naming constraints, and YAML validity. For skills, explicitly apply the Agent Skills specification, including string-to-string
metadataand space-separatedallowed-tools, plus the repository's existing 10-character description minimum.The shared YAML parser already accepts these scalar styles, so executable validation is unchanged. Regression tests cover both generated review prompts, five scalar styles, malformed YAML, and missing required metadata.
Type of Contribution
Additional Notes
This is a user-requested correction to review policy, not a relaxation of metadata validation. The public resource files under
instructions/are intentionally unchanged. Existing single-quoted examples and unrelated shell/code quoting advice remain intact.Validation:
node --test eng\open-pr-board.test.mjs eng\yaml-parser.test.mjs- passed, 37 tests.npm run build- passed; README and marketplace outputs remain unchanged. Existing external-plugin license warnings were emitted.bash eng/fix-line-endings.sh- passed.git diff --check- passed.npm run buildwas used instead of itsnpm startalias. No live GitHub Copilot canvas review was submitted or used for end-to-end validation. The new-resource and paid-service checklist items are not applicable.By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.