docs: add Screenshots/Video Demo section to PR template#2533
docs: add Screenshots/Video Demo section to PR template#2533tanzhenxin merged 3 commits intomainfrom
Conversation
Add a new section to the PR template encouraging contributors to attach visual demos of their changes. This helps reviewers understand changes quickly and prioritizes reviews. Also update CONTRIBUTING.md with guidelines for different types of changes (bug fixes, features, refactors). Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
📋 Review SummaryThis PR adds a "Screenshots / Video Demo" section to the PR template and updates CONTRIBUTING.md to encourage contributors to provide visual demos. The changes are well-structured, clear, and align with best practices for open-source contribution workflows. Overall, this is a solid documentation improvement that should help accelerate PR reviews. 🔍 General Feedback
🎯 Specific Feedback🔵 Low
✅ Highlights
|
Move "Dive Deeper" section after "Screenshots / Video Demo" to improve readability. Screenshots section is more actionable and should appear earlier in the template. Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
TLDR
Adds a "Screenshots / Video Demo" section to the PR template and updates CONTRIBUTING.md to encourage contributors to attach visual demos of their changes. This helps reviewers understand changes quickly and prioritize reviews.
Dive Deeper
This PR improves the contribution workflow by:
Adding a new section to the PR template (
.github/pull_request_template.md): A "Screenshots / Video Demo" section with clear guidance on what to include for different types of changes:Reordering sections for better flow: Moved "Dive Deeper" after "Screenshots / Video Demo" since the screenshots section is more actionable and should appear earlier in the template.
Updating the create-pr command (
.qwen/commands/qc/create-pr.md): Added instruction to leave the Screenshots section empty for the author to fill in manually, since visual demos are best captured by the human contributor.Updating CONTRIBUTING.md: Added a new step 6 about including screenshots/video demos, with guidance on what to provide for different change types. Renumbered the existing step 6 to step 7.
The goal is to speed up PR reviews by making it easier for reviewers to quickly understand the visual impact of changes.
Screenshots / Video Demo
N/A — no user-facing change. This is a documentation-only update to PR templates and contributing guidelines.
Reviewer Test Plan
.github/pull_request_template.md- verify the new section is well-formatted and the section ordering makes senseCONTRIBUTING.md- verify the new step 6 is properly integrated and step numbering is correct.qwen/commands/qc/create-pr.md- verify the new instruction is clearTesting Matrix
Note: This is a documentation-only change with no code to test.
Linked issues / bugs
No linked issues
🤖 Generated with Qwen Code