From 1a65b442f01c024b9810d9e28e9527c39857fcfe Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 2 Jan 2021 06:34:14 -0800 Subject: [PATCH] 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 Reviewed-By: Antoine du Hamel Reviewed-By: Yash Ladha --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 66efca5cd000e7..56632fda4c67eb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,15 @@ - -##### Checklist - +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) - -