Skip to content

Commit 56c00d7

Browse files
Trottdanielleadams
authored andcommitted
doc: simplify pull request template
Replace checklist with a list. Clarify when things like tests and benchmarks are needed. PR-URL: #36739 Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Yash Ladha <[email protected]>
1 parent e85fbb7 commit 56c00d7

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
11
<!--
2-
Thank you for your pull request. Please provide a description above and review
3-
the requirements below.
2+
Before submitting a pull request, please read
3+
https://github.com/nodejs/node/blob/master/CONTRIBUTING.md.
44
5-
Bug fixes and new features should include tests and possibly benchmarks.
5+
Commit message formatting guidelines:
6+
https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines
67
7-
Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
8-
-->
9-
10-
##### Checklist
11-
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
8+
For code changes:
9+
1. Include tests for any bug fixes or new features.
10+
2. Update documentation if relevant.
11+
3. Ensure that `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes.
1212
13-
- [ ] `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes
14-
- [ ] tests and/or benchmarks are included
15-
- [ ] documentation is changed or added
16-
- [ ] commit message follows [commit guidelines](https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines)
17-
18-
<!--
1913
Developer's Certificate of Origin 1.1
2014
2115
By making a contribution to this project, I certify that:

0 commit comments

Comments
 (0)