-
Notifications
You must be signed in to change notification settings - Fork 128
Description
Summary
Add mandatory quality gate to PR template requiring contributors to review chatmodes, prompts, and instructions with the prompt-builder agent before submission.
Background
AI artifact contributions benefit from validation by the specialized prompt-builder agent which checks for common issues, standards compliance, and quality gates. Currently this step is optional/implicit. Making it explicit in the PR template ensures consistent quality.
Objectives
- Add checkbox requiring
prompt-builderreview for AI artifact contributions - Place requirement prominently in type selection section
- Add detailed validation checklist for AI artifacts
- Improve submission quality through mandatory AI-assisted peer review
Changes
File: .github/PULL_REQUEST_TEMPLATE.md
Change 1: Type Selection Section
Add as first checkbox under "AI Artifacts:" type selection:
- [ ] Reviewed contribution with `prompt-builder` chatmode and addressed all feedbackThis appears before the 3 file type checkboxes (instructions/prompt/chatmode), ensuring contributors see the requirement immediately when selecting AI artifact contribution type.
Change 2: Detailed Checklist Section
Add new "AI Artifact Contributions" section in checklist:
### AI Artifact Contributions
<!-- If contributing a chatmode, prompt, or instruction, complete these checks -->
- [ ] Used `prompt-builder` chatmode to review contribution
- [ ] Addressed all feedback from `prompt-builder` review
- [ ] Verified contribution follows common standards and type-specific requirementsAcceptance Criteria
- Checkbox present in "AI Artifacts:" type selection section (as first item)
- Detailed "AI Artifact Contributions" checklist section added
- PR template passes markdown validation
- Template references are clear (backticks around
prompt-builder) - Language is imperative and action-oriented
Technical Notes
- Placement strategy: Dual placement (type selection + detailed checklist) ensures visibility without redundancy
- Agent reference: Uses backticks for code formatting:
prompt-builder - Validation: Template must pass
npm run lint:md
Usage Instructions
When contributing AI artifacts, contributors will:
- Select "AI Artifacts" in Type of Change section
- See immediate requirement: "Reviewed contribution with
prompt-builderchatmode" - Check detailed validation steps in AI Artifact Contributions checklist section
- Complete all 3 validation checkboxes before submitting PR
Related Issues
Part of AI artifact contribution documentation initiative (PR feat/ai-artifact-contrib-docs)