Skip to content

Commit 2da5f86

Browse files
gibfahnbnoordhuis
authored andcommitted
doc: add github PR and Issue templates
Give users reporting bugs a clearer idea of the info that will be helpful when reporting issues. PR-URL: #1228 Refs: https://github.com/nodejs/node/tree/master/.github Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
1 parent a46a770 commit 2da5f86

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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 issues with node-gyp,
6+
if you have an issue installing a specific module, please file an issue on
7+
that module's issue tracker (`npm issues modulename`).
8+
-->
9+
10+
* **Node Version**: <!-- `node -v` and `npm -v` -->
11+
* **Platform**: <!-- `uname -a` (UNIX), or `systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"` (Windows) -->
12+
* **Compiler**: <!-- `cc -v` (UNIX) or `msbuild /version & cl` (Windows) -->
13+
* **Module**: <!-- what you tried to build/install -->
14+
15+
<details><summary>Verbose output (from npm or node-gyp):</summary>
16+
17+
<!-- Paste your log between the backticks. Contents of npm-debug.log or verbose build output -->
18+
19+
```
20+
21+
```
22+
23+
</details>
24+
25+
<!-- Any further details -->
26+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--
2+
Thank you for your pull request. Please review the below requirements.
3+
4+
Contributor guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
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 <!-- Bug fixes and new features should include tests -->
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 -->
17+

0 commit comments

Comments
 (0)