From 2b6fc3c8d6d5b534ff5715d6b5ea60f9b150a28d Mon Sep 17 00:00:00 2001
From: Bartosz Sosnowski <bartosz@janeasystems.com>
Date: Tue, 7 Apr 2020 15:08:43 +0200
Subject: [PATCH] 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: https://github.com/nodejs/node-gyp/pull/2096
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
---
 .github/ISSUE_TEMPLATE.md | 32 +++++++++++++++++++++++++++-----
 bin/node-gyp.js           |  5 ++---
 2 files changed, 29 insertions(+), 8 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index b5bed7fdd1..485e26ecae 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,10 +1,16 @@
 <!--
-Thank you for reporting an issue. The more information you can give us, the
-better the chance we can fix your problem.
+Thank you for reporting an issue!
+
+Remember, this issue tracker is for reporting issues ONLY with node-gyp.
+
+If you have an issue installing a specific module, please file an issue on
+that module's issue tracker (`npm issues modulename`). Open issue here only if
+you are sure this is an issue with node-gyp, not with the module you are
+trying to build.
+
+Fill out the form below. We probably won't investigate an issue that does not
+provide the basic information we require.
 
-This issue tracker is for issues with node-gyp,
-if you have an issue installing a specific module, please file an issue on
-that module's issue tracker (`npm issues modulename`).
 -->
 
 * **Node Version**: <!-- `node -v` and `npm -v` -->
@@ -19,6 +25,22 @@ Paste your log here, between the backticks. It can be:
   - npm --verbose output,
   - or contents of npm-debug.log,
   - or output of node-gyp rebuild --verbose.
+Include the command you were trying to run.
+
+This should look like this:
+
+>npm --verbose
+npm info it worked if it ends with ok
+npm verb cli [
+npm verb cli   'C:\\...\\node\\13.9.0\\x64\\node.exe',
+npm verb cli   'C:\\...\\node\\13.9.0\\x64\\node_modules\\npm\\bin\\npm-cli.js',
+npm verb cli   '--verbose'
+npm verb cli ]
+npm info using npm@6.13.7
+npm info using node@v13.9.0
+
+Usage: npm <command>
+(...)
 ```
 
 </details>
diff --git a/bin/node-gyp.js b/bin/node-gyp.js
index 49b5721d02..8652ea21ec 100755
--- a/bin/node-gyp.js
+++ b/bin/node-gyp.js
@@ -131,9 +131,8 @@ function errorMessage () {
 
 function issueMessage () {
   errorMessage()
-  log.error('', ['This is a bug in `node-gyp`.',
-    'Try to update node-gyp and file an Issue if it does not help:',
-    '    <https://github.com/nodejs/node-gyp/issues>'
+  log.error('', ['Node-gyp failed to build your package.',
+    'Try to update npm and/or node-gyp and if it does not help file an issue with the package author.'
   ].join('\n'))
 }