summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChinmoy Chakraborty <chinmoy12c@gmail.com>2020-12-08 16:37:51 +0530
committerMichaƫl Zasso <targos@protonmail.com>2020-12-21 18:24:26 +0100
commiteb29a16bae6ec3bfc52cc5bd1578f6102aefa85c (patch)
tree30070f633de25c896f04f42d0d08d0676d63c914
parentf09985d42aa54ccc3226e852fa505c10bc935b86 (diff)
downloadnode-new-eb29a16bae6ec3bfc52cc5bd1578f6102aefa85c.tar.gz
doc: add issue reference to github pr template
The PR template should include a Reference isssue (Fixes #issue_number) so the PR can be tracked back to the issue easily.For a beginner trying to read PRs to become comfortable with the codebase,it is really helpful if one can directly reach the issue the PR fixes. Fixes: https://github.com/nodejs/node/issues/36338 PR-URL: https://github.com/nodejs/node/pull/36440 Reviewed-By: James M Snell <jasnell@gmail.com>
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md4
-rw-r--r--doc/guides/contributing/pull-requests.md4
2 files changed, 8 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 66efca5cd0..dd3a2964c8 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,6 +7,10 @@ Bug fixes and new features should include tests and possibly benchmarks.
Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
-->
+#### Related Issues
+
+Fixes: https://github.com/nodejs/node/issues/<issue_number>
+
##### Checklist
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md
index c61ac5ff37..627ae2218a 100644
--- a/doc/guides/contributing/pull-requests.md
+++ b/doc/guides/contributing/pull-requests.md
@@ -281,6 +281,10 @@ Bug fixes and new features should include tests and possibly benchmarks.
Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
-->
+#### Related Issues
+
+Fixes: https://github.com/nodejs/node/issues/<issue_number>
+
#### Checklist
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->