Skip to content

docs: add visual evidence section to PR template - #63

Open
BingqingLyu wants to merge 2 commits into
mainfrom
pr-2534-docs-add-pr-screenshot-check
Open

docs: add visual evidence section to PR template#63
BingqingLyu wants to merge 2 commits into
mainfrom
pr-2534-docs-add-pr-screenshot-check

Conversation

@BingqingLyu

@BingqingLyu BingqingLyu commented Apr 27, 2026

Copy link
Copy Markdown
Owner

Encourage contributors to include screenshots or video demos in PRs.

What this adds:

  • New 'Visual Evidence (Screenshots / Video)' section at the top of the PR template
  • Clear guidance on what to include for UI/CLI/API changes
  • Opt-out option for refactors, internal changes, docs-only PRs

Why:
A screenshot or short video showing the change in action helps reviewers pick this up faster. This reduces back-and-forth and speeds up PR review.

Effect:

  • Contributors are prompted to add visual evidence
  • If nothing visual to show, they note 'N/A' in the section
  • Reviewers can quickly see what changed in practice

Qwen Code Bot added 2 commits March 20, 2026 17:13
Encourage contributors to include screenshots or video demos in PRs.
Helps reviewers understand and validate changes faster.

If nothing visual to show (refactor, internal change), contributors
should note 'N/A' in the section.
When reviewing PRs, the bot now checks if the PR body contains
visual evidence (screenshots, videos, GIFs, or video links).

The bot will leave a friendly comment requesting visual evidence
only if:
- No images/videos/GIFs in the PR body
- No opt-out language (N/A, internal change, refactor, etc.)
- Not a docs-only change

This helps reviewers understand and validate changes faster.
Repository owner deleted a comment from github-actions Bot Apr 29, 2026
@BingqingLyu BingqingLyu added auto-merge-candidate auto-merge-candidate LOW risk, no cross-PR dependencies — safe to merge after quick review and removed auto-merge-candidate labels May 7, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

This pull request has had no activity for 60 days and is being marked as stale. It will be closed in another 30 days if no further activity occurs. To keep it open, push a new commit or leave a comment. Maintainers may apply pinned, status/blocked, status/on-hold, or status/ready-for-merge to exempt it from auto-close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-merge-candidate LOW risk, no cross-PR dependencies — safe to merge after quick review status/stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant