diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 773e4cc87..5245e621a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,19 @@ +## Screenshots / Video Demo + + + ## Reviewer Test Plan diff --git a/.qwen/commands/qc/create-pr.md b/.qwen/commands/qc/create-pr.md index f2b491925..8438f5405 100644 --- a/.qwen/commands/qc/create-pr.md +++ b/.qwen/commands/qc/create-pr.md @@ -25,6 +25,7 @@ Create a well-structured pull request with proper description and title. - Include context and motivation - List any breaking changes - Link related issues if provided, or use "No linked issues" + - Leave the "Screenshots / Video Demo" section empty for the author to fill in manually - Add this line at the end of PR body: "🤖 Generated with [Qwen Code](https://github.com/QwenLM/qwen-code)", with a line separator 4. **Set up PR** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84aa5520b..7af98e2c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,17 @@ Before submitting your PR, ensure that all automated checks are passing by runni If your PR introduces a user-facing change (e.g., a new command, a modified flag, or a change in behavior), you must also update the relevant documentation in the `/docs` directory. -#### 6. Write Clear Commit Messages and a Good PR Description +#### 6. Include a Screenshot or Video Demo + +To help reviewers understand your change quickly and prioritize reviews, please attach a screenshot or short video to your PR showing the change in action. + +- **For bug fixes:** Show the before and after behavior. +- **For new features:** Show the feature working end-to-end. +- **For refactors or internal-only changes:** Simply note "N/A — no user-facing change" in the demo section. + +PRs with visual demos tend to get reviewed much faster, so this is in your interest too! + +#### 7. Write Clear Commit Messages and a Good PR Description Your PR should have a clear, descriptive title and a detailed description of the changes. Follow the [Conventional Commits](https://www.conventionalcommits.org/) standard for your commit messages.