Skip to content

Commit 4b82ab8

Browse files
Add draft PR template (#57)
include draft `PR template` for repo Co-authored-by: Suporno Chaudhury <[email protected]>
1 parent 641ebb7 commit 4b82ab8

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

.github/pull_request_template.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## Description
2+
3+
_Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change_
4+
5+
Fixes # (issue)
6+
Dependent # (issue)
7+
## Current status
8+
9+
- [ ] Waiting for review
10+
- [ ] Waiting for comment resolution
11+
- [ ] Waiting for merge
12+
- [ ] Draft
13+
- [ ] Trivial PR (nominal cosmetic/typo/whitespace changes)
14+
15+
## Semantic Versioning
16+
Please delete options that are not relevant. Ensure same has been covered in the commit message as well.
17+
18+
- This is a `fix` change
19+
- This is a `feat` change
20+
- This is a `BREAKING CHANGE`
21+
22+
## Type of change
23+
24+
Please delete options that are not relevant.
25+
26+
- Bug fix (non-breaking change which fixes an issue)
27+
- New feature (non-breaking change which adds functionality)
28+
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
29+
- This change requires a documentation update
30+
31+
## How Has This Been Tested?
32+
33+
_Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration_
34+
35+
### Automated
36+
37+
### Manual
38+
39+
## Checklist:
40+
- [ ] My commit message mentions fix, feat, BREAKING CHANGE accordingly to increase the semantic versioning
41+
- [ ] My code follows the style guidelines of this project
42+
- [ ] I have performed a self-review of my own code
43+
- [ ] I have commented my code, particularly in hard-to-understand areas
44+
- [ ] I have made corresponding changes to the documentation
45+
- [ ] I have checked my code/docs and corrected any misspellings

0 commit comments

Comments
 (0)