microsoft / microsoft/winget-cli
Update pull request template: require evidence, tests, and AI disclosure
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 26.4k
- Forks
- 1.8k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 15
Description
Part of #6393.
Problem
The pull request template (.github/PULL_REQUEST_TEMPLATE.md) asks how a change was tested but does not prompt for visual evidence of working behavior, does not have a checkbox affirming tests were added/updated, and does not ask contributors to disclose AI assistance.
Proposed change
Update .github/PULL_REQUEST_TEMPLATE.md to add:
- An Evidence prompt in the Validation section requesting a screenshot or short recording demonstrating the change working (where applicable).
- A checklist item: Added or updated tests (or explained why not applicable).
- A checklist item: Disclosed any AI-assisted authoring (ties to the AI contribution policy sub-issue).
Keep the existing sections (Description, References, Validation, Checklist, Issue Type) intact and consistent with the current format.
Dependencies
- The AI disclosure checkbox should align with the wording from the AI-assisted contribution policy sub-issue.
Acceptance criteria
- PR template includes an evidence prompt, a tests checkbox, and an AI-assisted disclosure checkbox.
(Created with GitHub Copilot assistance.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open .github/PULL_REQUEST_TEMPLATE.md and compare its existing sections with the proposed changes. Add the Evidence prompt and the tests and AI-assisted disclosure checklist items, using wording aligned with the AI-assisted contribution policy sub-issue. Done means all three additions are present while the existing sections remain intact and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100