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: nodejs#36338 PR-URL: nodejs#36440 Reviewed-By: James M Snell <[email protected]>
sryze · Dec 16, 2020 · 4a6200e · 4a6200e
1 parent b558075
commit 4a6200e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git 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
@@ -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]. -->