Commit 56c00d7
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 <himself65@outlook.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yash Ladha <yash@yashladha.in>1 parent e85fbb7 commit 56c00d7
1 file changed
Lines changed: 8 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,21 +1,15 @@ | |||
| 1 | 1 | <!-- | |
| 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. | ||
| 4 | 4 | ||
| 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 | ||
| 6 | 7 | ||
| 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. | ||
| 12 | 12 | ||
| 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 | - <!-- | ||
| 19 | 13 | Developer's Certificate of Origin 1.1 | |
| 20 | 14 | ||
| 21 | 15 | By making a contribution to this project, I certify that: | |
0 commit comments