Skip to content

Commit 93237c5

Browse files
Trottdanielleadams
authored andcommitted
doc: remove replication of GitHub template
The pull-request template was replicated in the pull-requests.md which is a maintenance annoyance when changing the template. Replace the replication with a link to the raw template. PR-URL: #36590 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]>
1 parent 538f226 commit 93237c5

File tree

1 file changed

+4
-28
lines changed

1 file changed

+4
-28
lines changed

doc/guides/contributing/pull-requests.md

+4-28
Original file line numberDiff line numberDiff line change
@@ -268,34 +268,9 @@ $ git push origin my-branch
268268

269269
### Step 8: Opening the Pull Request
270270

271-
From within GitHub, opening a new Pull Request will present you with a template
272-
that should be filled out:
273-
274-
```markdown
275-
<!--
276-
Thank you for your Pull Request. Please provide a description above and review
277-
the requirements below.
278-
279-
Bug fixes and new features should include tests and possibly benchmarks.
280-
281-
Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
282-
-->
283-
284-
#### Related Issues
285-
286-
Fixes: https://github.com/nodejs/node/issues/<issue_number>
287-
288-
#### Checklist
289-
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
290-
291-
- [ ] `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes
292-
- [ ] tests and/or benchmarks are included
293-
- [ ] documentation is changed or added
294-
- [ ] commit message follows [commit guidelines](https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines)
295-
```
296-
297-
Please try to do your best at filling out the details, but feel free to skip
298-
parts if you're not sure what to put.
271+
From within GitHub, opening a new Pull Request will present you with a
272+
[pull request template][]. Please try to do your best at filling out the
273+
details, but feel free to skip parts if you're not sure what to put.
299274

300275
Once opened, Pull Requests are usually reviewed within a few days.
301276

@@ -630,4 +605,5 @@ More than one subsystem may be valid for any particular issue or pull request.
630605
[guide for writing tests in Node.js]: ../writing-tests.md
631606
[hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment
632607
[https://ci.nodejs.org/]: https://ci.nodejs.org/
608+
[pull request template]: https://raw.githubusercontent.com/nodejs/node/master/.github/PULL_REQUEST_TEMPLATE.md
633609
[running tests]: ../../../BUILDING.md#running-tests

0 commit comments

Comments
 (0)