Skip to content

Commit e57bc68

Browse files
authored
Write a new pull request template (#2276)
The new template emphasizes what actions the author and reviewer should perform.
1 parent d538171 commit e57bc68

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
1+
Fixes #nnnn
12

23
---
34

4-
###### Reviewer checklist
5+
###### Review checklist
56

6-
- [ ] Test coverage: `stack test --coverage`
7-
- [ ] Public API documentation: `stack haddock`
7+
The author performs the actions on the checklist.
8+
The reviewer evaluates the work and checks the boxes as they are completed.
9+
10+
- [ ] **Summary**
11+
Write a summary of the changes.
12+
Explain what you did to fix the issue, and why you did it.
13+
Present the changes in a logical order.
14+
Instead of writing a summary in the pull request,
15+
you may push a clean Git history.
16+
- [ ] **Documentation**
17+
Write documentation for new functions.
18+
Update documentation for functions that changed,
19+
or complete documentation where it is missing.
20+
- [ ] **Tests**
21+
Write unit tests for every change.
22+
Write the unit tests that were missing before the changes.
23+
Include any examples from the reported issue as integration tests.
24+
- [ ] **Clean up**
25+
The changes are already clean.
26+
Clean up anything near the changes that you noticed while working.
27+
This does not mean only spatially near the changes, but logically near:
28+
any code that interacts with the changes!

0 commit comments

Comments
 (0)