diff options
| author | Rich Trott <rtrott@gmail.com> | 2016-05-14 08:43:14 +0300 |
|---|---|---|
| committer | Evan Lucas <evanlucas@me.com> | 2016-05-17 16:38:42 +0300 |
| commit | ad895f490b203ab2111783bc44d519ad49103d72 (patch) | |
| tree | cfbd1e9328b0e6bb895e0b152e2a9e9f597f7623 /.github | |
| parent | 75adc6a0265dd20524d05524a0a7093c71b5d0ac (diff) | |
doc: trim GitHub template comments
Make the comments in the GitHub templates slightly more concise.
PR-URL: https://github.com/nodejs/node/pull/6755
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 13 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 14 |
2 files changed, 10 insertions, 17 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index dbd53cf2282..ac272f8149c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,19 +1,16 @@ <!-- -Thanks for wanting to report an issue you've found in Node.js. Please fill in -the template below by replacing the html comments with an appropriate answer. -If unsure about something, just do as best as you're able. +Thank you for reporting an issue. Please fill in the template below. If unsure +about something, just do as best as you're able. -version: usually output of `node -v` -platform: either `uname -a` output, or if Windows, version and 32 or 64-bit. -subsystem: optional -- if known please specify affected core module name. +Version: usually output of `node -v` +Platform: either `uname -a` output, or if Windows, version and 32 or 64-bit +Subsystem: if known, please specify affected core module name It will be much easier for us to fix the issue if a test case that reproduces the problem is provided. Ideally this test case should not have any external dependencies. We understand that it is not always possible to reduce your code to a small test case, but we would appreciate to have as much data as possible. - -Thank you! --> * **Version**: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 364754444ac..cce9351dc1e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,20 +1,18 @@ <!-- -Thank you for submitting a pull request to Node.js. Before you submit, please -review below requirements and walk through the checklist. You can 'tick' -a box by using the letter "x": [x]. +Thank you for your pull request. Please review below requirements and walk +through the checklist. You can 'tick' a box by using the letter "x": [x]. -Run the test suite by invoking: `make -j4 lint test` on linux or -`vcbuild test nosign` on Windows. +Run the test suite with: `make -j4 test` on UNIX or `vcbuild test nosign` on +Windows. If this aims to fix a regression or you’re adding a feature, make sure you also -write a test. Finally – if possible – a benchmark that quantifies your changes. +write a test. If possible, include a benchmark that quantifies your changes. Finally, read through our contributors guide and make adjustments as necessary: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md --> ##### Checklist - <!-- remove lines that do not apply to you --> - [ ] tests and code linting passes @@ -24,10 +22,8 @@ https://github.com/nodejs/node/blob/master/CONTRIBUTING.md ##### Affected core subsystem(s) - <!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) --> ##### Description of change - <!-- provide a description of the change below this comment --> |