Skip to content

Commit daa95dc

Browse files
committed
doc: add github PR and Issue templates
Give users reporting bugs a clearer idea of the info that will be helpful when reporting issues. Refs: https://github.com/nodejs/node/tree/master/.github
1 parent 35e1dbb commit daa95dc

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
Thank you for reporting an issue. The more information you can give us, the
3+
better the chance we can fix your problem.
4+
5+
This issue tracker is for bugs and issues found within node-gyp,
6+
if you have an issue installing a specific module, please file an issue on
7+
that module's issue tracker (find the link with `npm issues modulename`).
8+
9+
Please fill in as much of the template below as you're able.
10+
11+
Node Version: output of `node -v` and `npm -v`
12+
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)
13+
Compiler: output of `cc -v` (UNIX) or `msbuild.exe` (Windows)
14+
Module: the module you tried to install.
15+
-->
16+
17+
* **Node Version**:
18+
* **Platform**:
19+
* **Compiler**:
20+
* **Module**:
21+
22+
<details><summary>Verbose output (from npm or node-gyp):</summary>
23+
24+
<!-- Paste your log between the backticks. If you can't find npm-debug.log then
25+
do `export npm_config_loglevel=silly` (UNIX) or `set npm_config_loglevel=silly`
26+
(Windows) before running the `npm install`/`node-gyp build` command, and paste
27+
the output.
28+
-->
29+
30+
```
31+
32+
```
33+
34+
</details>
35+
36+
<!-- Enter any further details below this comment. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--
2+
Thank you for your pull request. Please review below requirements.
3+
4+
Bug fixes and new features should include tests.
5+
-->
6+
7+
##### Checklist
8+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
9+
10+
- [ ] `npm install && npm test` passes
11+
- [ ] tests are included
12+
- [ ] documentation is changed or added
13+
- [ ] commit message follows [commit guidelines](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-message-guidelines)
14+
15+
##### Description of change
16+
<!-- Provide a description of the change below this comment. -->

0 commit comments

Comments
 (0)