Skip to content

Commit 7426a25

Browse files
authored
Create PULL_REQUEST_TEMPLATE.md
1 parent 487ffc9 commit 7426a25

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## What does it do?
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+
7+
Please mention in the format "Fixes #issueNumber" or "Closes #issueNumber".
8+
This is important for semantic-release to correctly generate release tags and update issues.
9+
10+
## Type of change
11+
12+
Please delete options that are not relevant.
13+
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] This change requires a documentation update
18+
19+
# Checklist:
20+
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my own code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] Updated documentation (if applicable)
25+
- [ ] Added tests that prove my fix is effective or that my feature works
26+
- [ ] New and existing unit tests pass locally with my changes
27+
- [ ] My changes generate no new warnings
28+
- [ ] Added myself to contributors table
29+
- [ ] I have updated `docs/bundle.js` file (ran `yarn build:docs` and checked in the new `bundle.js` file)

0 commit comments

Comments
 (0)