Skip to content

Fix frontmatter quote-style guidance in PR reviews - #5605

Merged
aaronpowell merged 1 commit into
mainfrom
aaronpowell-frontmatter-quoting-guidance
Oct 25, 2026
Merged

aaronpowell merged 1 commit into
mainfrom
aaronpowell-frontmatter-quoting-guidance

Conversation

@aaronpowell

Copy link
Copy Markdown
Contributor

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution adds a new instruction, prompt, agent, skill, workflow, or canvas extension file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, skill, workflow, or canvas extension with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.
  • I am targeting the main branch 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 metadata and space-separated allowed-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

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New plugin.
  • New skill file.
  • New agentic workflow.
  • New canvas extension.
  • Update to existing instruction, prompt, agent, plugin, skill, workflow, or canvas extension.
  • Other (please specify):

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 build was used instead of its npm start alias. 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.

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>
@aaronpowell
aaronpowell requested a review from a team as a code owner October 25, 2026 23:05
Copilot AI max review requested due to automatic review settings October 25, 2026 23:05
@github-actions

github-actions Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

🚦 Submission status: 👀 Ready for review

Risk tier: merge-risk:high — Privileged execution, automation, or review-policy change
Required to merge: passing submission-gate checks plus 1 approval from reviewers with write access, including a maintainer with admin or maintain permission.

Why this tier
  • .github/copilot-instructions.md is a high-risk path (automation, scripts, MCP config, hooks, or review policy)
  • .github/extensions/open-pr-board/lib/review-prompt.mjs is a high-risk path (automation, scripts, MCP config, hooks, or review policy)
  • .github/extensions/open-pr-board/review-guidance.md is a high-risk path (automation, scripts, MCP config, hooks, or review policy)
  • .github/skills/code-review/SKILL.md is a high-risk path (automation, scripts, MCP config, hooks, or review policy)
  • eng/open-pr-board.test.mjs is a high-risk path (automation, scripts, MCP config, hooks, or review policy)
  • eng/yaml-parser.test.mjs is a high-risk path (automation, scripts, MCP config, hooks, or review policy)

Automated checks

Check Status Details
Line endings ✅ Passed Passed · logs
Spelling ✅ Passed Passed · logs
Contributor reputation ✅ Passed Passed · logs
Duplicate resource scan ⏳ Pending (advisory, non-blocking) Running · logs
PR quality signal ⏳ Pending (advisory, non-blocking) Running · logs

Review

  • Approvals: 0/1
  • Assigned reviewer: not assigned yet — comment /request-review to ask for one
  • Review target date: not set
  • Still needed: 1 more approval(s); an approval from a maintainer with admin or maintain permission
  • The core-maintainers pool is not staffed yet; an approver with admin or maintain permission is required instead.

Commands

Command Who What it does
/rerun-checks PR author, maintainers Re-runs failed or incomplete checks and re-evaluates this gate
/request-review PR author, maintainers Asks the review rotation to assign a reviewer (adds needs-reviewer)

Updated for ab01f8a · gate run · This comment is maintained automatically — see submission gate docs.

@github-actions

Copy link
Copy Markdown
Contributor

🟡 Contributor Reputation Check: MEDIUM risk

Check Risk
Profile MEDIUM
Credential audit NONE

Maintainers: please review this contributor before merging.
See the workflow run for full details.
Automated check powered by AGT.

@github-actions github-actions Bot added needs-review:MEDIUM Contributor reputation check flagged MEDIUM risk ready-for-review Submission passed intake validation and is ready for maintainer review and removed awaiting-automation labels Oct 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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

@aaronpowell
aaronpowell merged commit 3b96c56 into main Oct 25, 2026
30 of 31 checks passed
@aaronpowell
aaronpowell deleted the aaronpowell-frontmatter-quoting-guidance branch October 25, 2026 23:20

This branch was successfully deployed

1 active deployment
github-pages — ab01f8a8 Deployed Oct 25, 2026 by aaronpowell via deploy #1099
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge-risk:high needs-review:MEDIUM Contributor reputation check flagged MEDIUM risk ready-for-review Submission passed intake validation and is ready for maintainer review website-update PR touches website content or code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants