Skip to content

Commit bec8cdf

Browse files
committed
add PULL_REQUEST_TEMPLATE
1 parent cd522bf commit bec8cdf

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## 📋 Description
2+
3+
Please include a summary of the changes and the related issue (if applicable).
4+
5+
- What is the motivation and context of this pull request?
6+
- What problem does it solve?
7+
- Link to related issues or pull requests, if applicable.
8+
9+
## 🛠️ Types of Changes
10+
11+
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
16+
- [ ] Documentation update
17+
- [ ] Refactoring (code changes that neither fix a bug nor add a feature)
18+
- [ ] Performance improvement
19+
20+
## 🧪 How Has This Been Tested?
21+
22+
Please describe the tests that you ran to verify your changes.
23+
24+
- Include details on test configurations:
25+
- Operating System:
26+
- Node.js version:
27+
- Any other relevant information for testing.
28+
29+
## 📸 Screenshots (if applicable)
30+
31+
If your changes include UI updates, please provide screenshots.
32+
33+
## 🔗 Related Issues
34+
35+
Please link to the issues this PR is related to:
36+
37+
- Closes # (issue number)
38+
- Fixes # (issue number)
39+
- Resolves # (issue number)
40+
41+
## ✅ Checklist
42+
43+
Before submitting your PR, please ensure the following tasks are complete:
44+
45+
- [ ] My code follows the code style of this project.
46+
- [ ] I have performed a self-review of my code.
47+
- [ ] I have commented my code, particularly in hard-to-understand areas.
48+
- [ ] I have made corresponding changes to the documentation.
49+
- [ ] I have added tests that prove my fix is effective or that my feature works.
50+
- [ ] New and existing unit tests pass locally with my changes.
51+
- [ ] I have updated the CHANGELOG.md file (if applicable).
52+
- [ ] My changes do not generate new warnings.
53+
54+
## 📄 Additional Comments
55+
56+
Is there anything else you want to mention about this pull request? If so, please do so here.

0 commit comments

Comments
 (0)