diff options
| author | Johan Bergström <bugs@bergstroem.nu> | 2016-03-15 16:06:09 +1100 |
|---|---|---|
| committer | Johan Bergström <bugs@bergstroem.nu> | 2016-04-06 09:20:02 +1000 |
| commit | b743d82ffc10ca74253ede11eddca37f96f48b0a (patch) | |
| tree | 65336c1afbc0a4d376c3303ed668e0f967259fd7 /.github/ISSUE_TEMPLATE.md | |
| parent | f4ebd5989a76c1986d0ca5a5476ca285081000ee (diff) | |
| download | android-node-v8-b743d82ffc10ca74253ede11eddca37f96f48b0a.tar.gz android-node-v8-b743d82ffc10ca74253ede11eddca37f96f48b0a.tar.bz2 android-node-v8-b743d82ffc10ca74253ede11eddca37f96f48b0a.zip | |
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: https://github.com/nodejs/node/pull/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>
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 0d10c2a841..dbd53cf228 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,14 +1,23 @@ -_Thanks for wanting to report an issue you've found in Node.js. Please delete -this text and fill in the template below. If unsure about something, just do as -best as you're able._ - -_Note that 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**: _output of `node -v`_ -* **Platform**: _either `uname -a` output, or if Windows, version and 32-bit or - 64-bit_ -* **Subsystem**: _optional. if known - please specify affected core module name_ +<!-- +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. + +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. + +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**: +* **Platform**: +* **Subsystem**: + +<!-- Enter your issue details below this comment. --> |