mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-04-26 10:41:41 +00:00
docs: add Screenshots/Video Demo section to PR template
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>
This commit is contained in:
parent
fbf5ed57d6
commit
99613b85ce
3 changed files with 25 additions and 1 deletions
13
.github/pull_request_template.md
vendored
13
.github/pull_request_template.md
vendored
|
|
@ -6,6 +6,19 @@
|
|||
|
||||
<!-- more thoughts and in-depth discussion here -->
|
||||
|
||||
## Screenshots / Video Demo
|
||||
|
||||
<!--
|
||||
Please attach a screenshot or short video showing your change in action.
|
||||
This helps reviewers understand the change quickly and prioritize reviews.
|
||||
|
||||
- For bug fixes: show the before/after behavior.
|
||||
- For features: show the new functionality in use.
|
||||
- For refactors or internal changes with no visible effect: write "N/A — no user-facing change" and briefly explain why.
|
||||
|
||||
PRs with visual demos typically get reviewed much faster!
|
||||
-->
|
||||
|
||||
## Reviewer Test Plan
|
||||
|
||||
<!-- when a person reviews your code they should ideally be pulling and running that code. How would they validate your change works and if relevant what are some good classes of example prompts and ways they can exercise your changes -->
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue