Commit b725437
committed
doc: minor rewording to the GitHub issue/pr templates
- Templates are now a bit more consistent with phrasing.
- Simplified a bit.
PR-URL: #7403
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>1 parent 6b1fc63 commit b725437
2 files changed
Lines changed: 10 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,9 +1,9 @@ | |||
| 1 | 1 | <!-- | |
| 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. | ||
| 2 | + Thank you for reporting an issue. | ||
| 3 | + Please fill in as much of the template below as you're able. | ||
| 4 | 4 | ||
| 5 | - Version: usually output of `node -v` | ||
| 6 | - Platform: either `uname -a` output, or if Windows, version and 32 or 64-bit | ||
| 5 | + Version: output of `node -v` | ||
| 6 | + Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) | ||
| 7 | 7 | Subsystem: if known, please specify affected core module name | |
| 8 | 8 | ||
| 9 | 9 | If possible, please provide code that demonstrates the problem, keeping it as | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,23 +1,22 @@ | |||
| 1 | 1 | <!-- | |
| 2 | 2 | Thank you for your pull request. Please review below requirements. | |
| 3 | 3 | ||
| 4 | - Bug fixes and new features should include tests and possibly a benchmark. | ||
| 4 | + Bug fixes and new features should include tests and possibly benchmarks. | ||
| 5 | 5 | ||
| 6 | 6 | Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md | |
| 7 | 7 | --> | |
| 8 | 8 | ||
| 9 | 9 | ##### Checklist | |
| 10 | 10 | <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> | |
| 11 | 11 | ||
| 12 | - - [ ] `make -j4 test` (UNIX) or `vcbuild test nosign` (Windows) passes | ||
| 13 | - - [ ] a test and/or benchmark is included | ||
| 12 | + - [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes | ||
| 13 | + - [ ] tests and/or benchmarks are included | ||
| 14 | 14 | - [ ] documentation is changed or added | |
| 15 | - - [ ] the commit message follows commit guidelines | ||
| 16 | - | ||
| 15 | + - [ ] commit message follows commit guidelines | ||
| 17 | 16 | ||
| 18 | 17 | ##### Affected core subsystem(s) | |
| 19 | - <!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) --> | ||
| 18 | + <!-- Provide affected core subsystem(s) (like doc, cluster, crypto, etc). --> | ||
| 20 | 19 | ||
| 21 | 20 | ||
| 22 | 21 | ##### Description of change | |
| 23 | - <!-- provide a description of the change below this comment --> | ||
| 22 | + <!-- Provide a description of the change below this comment. --> | ||
0 commit comments