Skip to content

Commit b33b490

Browse files
Simplify PR Template (#75)
* docs: improvise PR template * docs: update PR template Co-authored-by: James George <jamesgeorge998001@gmail.com>
1 parent f7ca5a4 commit b33b490

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
1-
## Description
1+
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. -->
22

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.
3+
**What kind of change does this PR introduce?**
4+
<!-- E.g. a bugfix, feature, refactoring, build related change, etc… -->
45

5-
Fixes # (issue)
6+
**Did you add tests for your changes?**
67

7-
## Type of change
8+
**If relevant, did you update the documentation?**
89

9-
Please delete options that are not relevant.
10+
**Summary**
1011

11-
- [ ] Bug fix (non-breaking change which fixes an issue)
12-
- [ ] New feature (non-breaking change which adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] This change requires a documentation update
12+
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
13+
<!-- Try to link to an open issue for more information. -->
1514

16-
## Checklist:
15+
**Does this PR introduce a breaking change?**
16+
<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
1717

18-
- [ ] My code follows the style guidelines of this project
19-
- [ ] I have performed a self-review of my own code
20-
- [ ] I have commented my code, particularly in hard-to-understand areas
21-
- [ ] I have made corresponding changes to the documentation
22-
- [ ] My changes generate no new warnings
23-
- [ ] I have added tests that prove my fix is effective or that my feature works
24-
- [ ] New and existing unit tests pass locally with my changes
25-
- [ ] Any dependent changes have been merged and published in downstream modules
18+
**Other information**

0 commit comments

Comments
 (0)