Skip to content

Commit 2b6fc3c

Browse files
bzozrvagg
authored andcommitted
doc, bin: stop suggesting opening node-gyp issues
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker. It also makes the issue template more explicit about providing the logs. PR-URL: #2096 Reviewed-By: Christian Clauss <[email protected]> Reviewed-By: Rod Vagg <[email protected]>
1 parent fb2e80d commit 2b6fc3c

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

Diff for: .github/ISSUE_TEMPLATE.md

+27-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
<!--
2-
Thank you for reporting an issue. The more information you can give us, the
3-
better the chance we can fix your problem.
2+
Thank you for reporting an issue!
3+
4+
Remember, this issue tracker is for reporting issues ONLY with node-gyp.
5+
6+
If you have an issue installing a specific module, please file an issue on
7+
that module's issue tracker (`npm issues modulename`). Open issue here only if
8+
you are sure this is an issue with node-gyp, not with the module you are
9+
trying to build.
10+
11+
Fill out the form below. We probably won't investigate an issue that does not
12+
provide the basic information we require.
413
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`).
814
-->
915

1016
* **Node Version**: <!-- `node -v` and `npm -v` -->
@@ -19,6 +25,22 @@ Paste your log here, between the backticks. It can be:
1925
- npm --verbose output,
2026
- or contents of npm-debug.log,
2127
- or output of node-gyp rebuild --verbose.
28+
Include the command you were trying to run.
29+
30+
This should look like this:
31+
32+
>npm --verbose
33+
npm info it worked if it ends with ok
34+
npm verb cli [
35+
npm verb cli 'C:\\...\\node\\13.9.0\\x64\\node.exe',
36+
npm verb cli 'C:\\...\\node\\13.9.0\\x64\\node_modules\\npm\\bin\\npm-cli.js',
37+
npm verb cli '--verbose'
38+
npm verb cli ]
39+
npm info using [email protected]
40+
npm info using [email protected]
41+
42+
Usage: npm <command>
43+
(...)
2244
```
2345

2446
</details>

Diff for: bin/node-gyp.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,8 @@ function errorMessage () {
131131

132132
function issueMessage () {
133133
errorMessage()
134-
log.error('', ['This is a bug in `node-gyp`.',
135-
'Try to update node-gyp and file an Issue if it does not help:',
136-
' <https://github.com/nodejs/node-gyp/issues>'
134+
log.error('', ['Node-gyp failed to build your package.',
135+
'Try to update npm and/or node-gyp and if it does not help file an issue with the package author.'
137136
].join('\n'))
138137
}
139138

0 commit comments

Comments
 (0)