Skip to content

Commit caf1f5f

Browse files
committed
GitHub pull request template
The template provides guidance and a check-list to submitters to make sure code reviews can be as efficient as possible.
1 parent 499ccf1 commit caf1f5f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

.github/pull_request_template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!---
2+
Thank you for your contribution. Please make sure your pull request fulfils all of the below requirements. If you cannot currently tick all the boxes, but would still like to create a PR, then add the label "work in progress" and assign the PR to yourself.
3+
--->
4+
5+
- [ ] Each commit message has a non-empty body, answering the "Why?" question.
6+
- [ ] My contribution is formatting in line with CODING_STANDARD.md.
7+
- [ ] Methods or procedures I have added are documented.
8+
- [ ] Regression or unit tests are included, or existing tests cover the modified code.
9+
- [ ] My commit message includes data points confirming performance improvements (if claimed).
10+
- [ ] My PR is restricted to a single feature or bugfix.
11+
- [ ] Whitespace or formatting changes outside the feature-related changed lines are in commits of their own.
12+
13+
<!---
14+
See, e.g., https://chris.beams.io/posts/git-commit/ for general guidelines on commit messages.
15+
16+
If you have created commits mixing multiple features and/or unrelated whitespace changes, use a sequence involving git reset and git add -p to fix this.
17+
--->

0 commit comments

Comments
 (0)