docs: add visual evidence section to PR template - #63
Open
BingqingLyu wants to merge 2 commits into
Open
Conversation
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.
|
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Encourage contributors to include screenshots or video demos in PRs.
What this adds:
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: