Skip to content

Commit a94d95e

Browse files
authored
Update PULL_REQUEST_TEMPLATE.md
1 parent 911a979 commit a94d95e

File tree

1 file changed

+44
-19
lines changed

1 file changed

+44
-19
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 44 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,51 @@
1-
# Change
1+
# Pull Request Description
22

3-
***Feel free to remove this sample text***
4-
>Thank you for your contribution !
5-
Please include a summary of the change and which issue is fixed.
6-
Please also include relevant motivation and context.
7-
List any dependencies that are required for this change.
3+
## Summary
4+
[Provide a brief description of the changes in this PR]
5+
6+
### Issue Reference
7+
Fixes #[Issue Number]
8+
9+
### Motivation and Context
10+
- Why is this change needed?
11+
- What problem does it solve?
12+
- If it fixes an open issue, please link to the issue here
13+
14+
### Dependencies
15+
- List any dependencies that are required for this change
16+
- Include any configuration changes needed
17+
- Note any version updates required
818

919
## Type of Change
20+
Please mark the relevant option with an `x`:
21+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
22+
- [ ] ✨ New feature (non-breaking change which adds functionality)
23+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
24+
- [ ] 📝 Documentation update (Wiki/README/Code comments)
25+
- [ ] ♻️ Refactor (code improvement without functional changes)
26+
- [ ] 🎨 Style update (formatting, renaming)
27+
- [ ] 🔧 Configuration change
28+
- [ ] 📦 Dependency update
1029

11-
Please delete options that are not relevant.
30+
## Testing
31+
- [ ] I have added unit tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
- [ ] I have tested this code in the following browsers/environments: [list environments]
1234

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 not work as expected)
16-
- [ ] This change requires a documentation update (Wiki)
17-
- [ ] Refactor of existing code
35+
## Quality Checklist
36+
- [ ] I have reviewed my own code before requesting review
37+
- [ ] I have verified there are no other open Pull Requests for the same update/change
38+
- [ ] All CI/CD pipelines pass without errors or warnings
39+
- [ ] My code follows the established style guidelines of this project
40+
- [ ] I have added necessary documentation (if appropriate)
41+
- [ ] I have commented my code, particularly in complex areas
42+
- [ ] I have made corresponding changes to the README and other relevant documentation
43+
- [ ] My changes generate no new warnings
44+
- [ ] I have performed a self-review of my own code
45+
- [ ] My code is properly formatted according to project standards
1846

19-
## Checklist
47+
## Screenshots/Recordings (if appropriate)
48+
[Add screenshots or recordings that demonstrate the changes]
2049

21-
- [ ] I'm sure there are no other open Pull Requests for the same update/change
22-
- [ ] My corresponding pipelines / checks run clean and green without any errors or warnings
23-
- [ ] My code follows the style guidelines of this project
24-
- [ ] I have commented my code, particularly in hard-to-understand areas
25-
- [ ] I have made corresponding changes to the documentation (readme)
26-
- [ ] I did format my code
50+
## Additional Notes
51+
[Add any additional information that might be helpful for reviewers]

0 commit comments

Comments
 (0)