From dc5f4dcd28005147645480a5ca07195eb1035ea7 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Tue, 15 Feb 2022 10:50:26 +0000 Subject: [PATCH] Issue templates: improve guidance, increase filtering --- .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++--- .github/ISSUE_TEMPLATE/installation.md | 29 ++++++++++++--- .github/ISSUE_TEMPLATE/possible-bug.md | 43 +++++++++++++++++++---- .github/ISSUE_TEMPLATE/question.md | 18 +++++++--- 4 files changed, 92 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 69fc9b99..d87e090a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,12 +5,24 @@ labels: enhancement --- -What are you trying to achieve? +## Feature request -Have you searched for similar feature requests? +### What are you trying to achieve? -What would you expect the API to look like? + -What alternatives have you considered? +### When you searched for similar feature requests, what did you find that might be related? -Is there a sample image that helps explain? + + +### What would you expect the API to look like? + + + +### What alternatives have you considered? + + + +### Please provide sample image(s) that help explain this feature + + diff --git a/.github/ISSUE_TEMPLATE/installation.md b/.github/ISSUE_TEMPLATE/installation.md index 313e9d2c..b8876f60 100644 --- a/.github/ISSUE_TEMPLATE/installation.md +++ b/.github/ISSUE_TEMPLATE/installation.md @@ -7,11 +7,24 @@ labels: installation -Did you see the [documentation relating to installation](https://sharp.pixelplumbing.com/install)? +## Possible install-time or require-time problem -Have you ensured the architecture and platform of Node.js used for `npm install` is the same as the architecture and platform of Node.js used at runtime? + -Are you using the latest version? Is the version currently in use as reported by `npm ls sharp` the same as the latest version as reported by `npm view sharp dist-tags.latest`? +- [ ] I have read the [documentation relating to installation](https://sharp.pixelplumbing.com/install)? +- [ ] I have ensured that the architecture and platform of Node.js used for `npm install` is the same as the architecture and platform of Node.js used at runtime. + +### Are you using the latest version of sharp? + + + +- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`. + +If you cannot confirm this, please upgrade to the latest version and try again before opening an issue. + +If you are using another package which depends on a version of `sharp` that is not the latest, please open an issue against that package instead. + +### Is this a problem with filesystem permissions? If you are using npm v6 or earlier and installing as a `root` or `sudo` user, have you tried with the `npm install --unsafe-perm` flag? @@ -19,6 +32,12 @@ If you are using npm v7 or later, does the user running `npm install` own the di If you are using the `ignore-scripts` feature of `npm`, have you tried with the `npm install --ignore-scripts=false` flag? -What is the complete output of running `npm install --verbose sharp`? Have you checked this output for useful error messages? +### What is the complete output of running `npm install --verbose sharp`? -What is the output of running `npx envinfo --binaries --system`? +
+ +
+ +### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`? + + diff --git a/.github/ISSUE_TEMPLATE/possible-bug.md b/.github/ISSUE_TEMPLATE/possible-bug.md index 14b21b91..5cf0b615 100644 --- a/.github/ISSUE_TEMPLATE/possible-bug.md +++ b/.github/ISSUE_TEMPLATE/possible-bug.md @@ -7,14 +7,45 @@ labels: triage -Are you using the latest version? Is the version currently in use as reported by `npm ls sharp` the same as the latest version as reported by `npm view sharp dist-tags.latest`? +## Possible bug -What are the steps to reproduce? +### Is this a possible bug in a feature of sharp, unrelated to installation? -What is the expected behaviour? + -Are you able to provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem? +- [ ] Running `npm install sharp` completes without error. +- [ ] Running `node -e "require('sharp')"` completes without error. -Are you able to provide a sample image that helps explain the problem? +If you cannot confirm both of these, please open an +[installation issue](https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md) +instead. -What is the output of running `npx envinfo --binaries --system`? +### Are you using the latest version of sharp? + + + +- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`. + +If you cannot confirm this, please upgrade to the latest version and try again before opening an issue. + +If you are using another package which depends on a version of `sharp` that is not the latest, please open an issue against that package instead. + +### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`? + + + +### What are the steps to reproduce? + + + +### What is the expected behaviour? + + + +### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem + + + +### Please provide sample image(s) that help explain this problem + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 92e31e4f..8fbdb5f4 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,10 +7,20 @@ labels: question -What are you trying to achieve? +## Question about an existing feature -Have you searched for similar questions? +### What are you trying to achieve? -Are you able to provide a minimal, standalone code sample that demonstrates this question? + -Are you able to provide a sample image that helps explain the question? +### When you searched for similar issues, what did you find that might be related? + + + +### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this question + + + +### Please provide sample image(s) that help explain this question + +