Skip to content

Commit ad895f4

Browse files
Trottevanlucas
authored andcommitted
doc: trim GitHub template comments
Make the comments in the GitHub templates slightly more concise. PR-URL: #6755 Reviewed-By: Johan Bergström <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rod Vagg <[email protected]>
1 parent 75adc6a commit ad895f4

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
<!--
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.
2+
Thank you for reporting an issue. Please fill in the template below. If unsure
3+
about something, just do as best as you're able.
54
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.
5+
Version: usually output of `node -v`
6+
Platform: either `uname -a` output, or if Windows, version and 32 or 64-bit
7+
Subsystem: if known, please specify affected core module name
98
109
It will be much easier for us to fix the issue if a test case that reproduces
1110
the problem is provided. Ideally this test case should not have any external
1211
dependencies. We understand that it is not always possible to reduce your code
1312
to a small test case, but we would appreciate to have as
1413
much data as possible.
15-
16-
Thank you!
1714
-->
1815

1916
* **Version**:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
<!--
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].
2+
Thank you for your pull request. Please review below requirements and walk
3+
through the checklist. You can 'tick' a box by using the letter "x": [x].
54
6-
Run the test suite by invoking: `make -j4 lint test` on linux or
7-
`vcbuild test nosign` on Windows.
5+
Run the test suite with: `make -j4 test` on UNIX or `vcbuild test nosign` on
6+
Windows.
87
98
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.
9+
write a test. If possible, include a benchmark that quantifies your changes.
1110
1211
Finally, read through our contributors guide and make adjustments as necessary:
1312
https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
1413
-->
1514

1615
##### Checklist
17-
1816
<!-- remove lines that do not apply to you -->
1917

2018
- [ ] tests and code linting passes
@@ -24,10 +22,8 @@ https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
2422

2523

2624
##### Affected core subsystem(s)
27-
2825
<!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) -->
2926

3027

3128
##### Description of change
32-
3329
<!-- provide a description of the change below this comment -->

0 commit comments

Comments
 (0)