diff options
| author | Rich Trott <rtrott@gmail.com> | 2021-01-02 17:34:14 +0300 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2021-01-12 15:10:33 +0300 |
| commit | 56c00d7b2fe5cdd3f8600a42302ec523ddd6224b (patch) | |
| tree | 485bb45f0481c5bce2d7bb26a4cd8b454bfadcdc /.github | |
| parent | e85fbb778df90dbd9bf942217371cfd1ca0d48a4 (diff) | |
doc: simplify pull request template
Replace checklist with a list. Clarify when things like tests and
benchmarks are needed.
PR-URL: https://github.com/nodejs/node/pull/36739
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yash Ladha <yash@yashladha.in>
Diffstat (limited to '.github')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 66efca5cd00..56632fda4c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,15 @@ <!-- -Thank you for your pull request. Please provide a description above and review -the requirements below. +Before submitting a pull request, please read +https://github.com/nodejs/node/blob/master/CONTRIBUTING.md. -Bug fixes and new features should include tests and possibly benchmarks. +Commit message formatting guidelines: +https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines -Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md ---> - -##### Checklist -<!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> +For code changes: +1. Include tests for any bug fixes or new features. +2. Update documentation if relevant. +3. Ensure that `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes. -- [ ] `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes -- [ ] tests and/or benchmarks are included -- [ ] documentation is changed or added -- [ ] commit message follows [commit guidelines](https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines) - -<!-- Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: |