Skip to content

Commit c0376ae

Browse files
authored
Fix pull request template formatting (#2288)
The pull request box is not formatted in the same way as other Markdown around the GitHub site, so looking at the preview after the last changes to the template gave the wrong impression.
1 parent c0fdb5d commit c0376ae

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,9 @@ Fixes #nnnn
44

55
###### Review checklist
66

7-
The author performs the actions on the checklist.
8-
The reviewer evaluates the work and checks the boxes as they are completed.
7+
The author performs the actions on the checklist. The reviewer evaluates the work and checks the boxes as they are completed.
98

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!
9+
- [ ] **Summary.** Write a summary of the changes. Explain what you did to fix the issue, and why you did it. Present the changes in a logical order. Instead of writing a summary in the pull request, you may push a clean Git history.
10+
- [ ] **Documentation.** Write documentation for new functions. Update documentation for functions that changed, or complete documentation where it is missing.
11+
- [ ] **Tests.** Write unit tests for every change. Write the unit tests that were missing before the changes. Include any examples from the reported issue as integration tests.
12+
- [ ] **Clean up.** The changes are already clean. Clean up anything near the changes that you noticed while working. This does not mean only spatially near the changes, but logically near: any code that interacts with the changes!

0 commit comments

Comments
 (0)