Skip to content

Commit b743d82

Browse files
committed
doc: improve github templates by using comments
Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: #5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
1 parent f4ebd59 commit b743d82

File tree

2 files changed

+48
-30
lines changed

2 files changed

+48
-30
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
1-
_Thanks for wanting to report an issue you've found in Node.js. Please delete
2-
this text and fill in the template below. If unsure about something, just do as
3-
best as you're able._
4-
5-
_Note that it will be much easier for us to fix the issue if a test case that
6-
reproduces the problem is provided. Ideally this test case should not have any
7-
external dependencies. We understand that it is not always possible to reduce
8-
your code to a small test case, but we would appreciate to have as much data as
9-
possible. Thank you!_
10-
11-
* **Version**: _output of `node -v`_
12-
* **Platform**: _either `uname -a` output, or if Windows, version and 32-bit or
13-
64-bit_
14-
* **Subsystem**: _optional. if known - please specify affected core module name_
1+
<!--
2+
Thanks for wanting to report an issue you've found in Node.js. Please fill in
3+
the template below by replacing the html comments with an appropriate answer.
4+
If unsure about something, just do as best as you're able.
5+
6+
version: usually output of `node -v`
7+
platform: either `uname -a` output, or if Windows, version and 32 or 64-bit.
8+
subsystem: optional -- if known please specify affected core module name.
9+
10+
It will be much easier for us to fix the issue if a test case that reproduces
11+
the problem is provided. Ideally this test case should not have any external
12+
dependencies. We understand that it is not always possible to reduce your code
13+
to a small test case, but we would appreciate to have as
14+
much data as possible.
15+
16+
Thank you!
17+
-->
18+
19+
* **Version**:
20+
* **Platform**:
21+
* **Subsystem**:
22+
23+
<!-- Enter your issue details below this comment. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
1-
### Pull Request check-list
1+
<!--
2+
Thank you for submitting a pull request to Node.js. Before you submit, please
3+
review below requirements and walk through the checklist. You can 'tick'
4+
a box by using the letter "x": [x].
25
3-
_Please make sure to review and check all of these items:_
6+
Run the test suite by invoking: `make -j4 lint test` on linux or
7+
`vcbuild test nosign` on Windows.
48
5-
- [ ] Does `make -j8 test` (UNIX) or `vcbuild test nosign` (Windows) pass with
6-
this change (including linting)?
7-
- [ ] Is the commit message formatted according to [CONTRIBUTING.md][0]?
8-
- [ ] If this change fixes a bug (or a performance problem), is a regression
9-
test (or a benchmark) included?
10-
- [ ] Is a documentation update included (if this change modifies
11-
existing APIs, or introduces new ones)?
9+
If this aims to fix a regression or you’re adding a feature, make sure you also
10+
write a test. Finally – if possible – a benchmark that quantifies your changes.
1211
13-
_NOTE: these things are not required to open a PR and can be done
14-
afterwards / while the PR is open._
12+
Finally, read through our contributors guide and make adjustments as necessary:
13+
https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
14+
-->
1515

16-
### Affected core subsystem(s)
16+
##### Checklist
1717

18-
_Please provide affected core subsystem(s) (like buffer, cluster, crypto, etc)_
18+
<!-- remove lines that do not apply to you -->
1919

20-
[0]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit
20+
- [ ] tests and code linting passes
21+
- [ ] a test and/or benchmark is included
22+
- [ ] documentation is changed or added
23+
- [ ] the commit message follows commit guidelines
2124

22-
### Description of change
2325

24-
_Please provide a description of the change here._
26+
##### Affected core subsystem(s)
27+
28+
<!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) -->
29+
30+
31+
##### Description of change
32+
33+
<!-- provide a description of the change below this comment -->

0 commit comments

Comments
 (0)