mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 10:30:15 +02:00
Issue templates: improve guidance, increase filtering
This commit is contained in:
Lovell Fuller
parent
735793ba99
commit
dc5f4dcd28
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -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?
|
||||
<!-- Please provide context here. -->
|
||||
|
||||
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?
|
||||
<!-- Please demonstrate your research here. -->
|
||||
|
||||
### What would you expect the API to look like?
|
||||
|
||||
<!-- Please provide your suggestions here. -->
|
||||
|
||||
### What alternatives have you considered?
|
||||
|
||||
<!-- Please provide your ideas here. -->
|
||||
|
||||
### Please provide sample image(s) that help explain this feature
|
||||
|
||||
<!-- Please provide links to one or more images here. -->
|
||||
|
||||
29
.github/ISSUE_TEMPLATE/installation.md
vendored
29
.github/ISSUE_TEMPLATE/installation.md
vendored
@ -7,11 +7,24 @@ labels: installation
|
||||
|
||||
<!-- Please try to answer as many of these questions as possible. -->
|
||||
|
||||
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?
|
||||
<!-- Please place an [x] in the box to confirm. -->
|
||||
|
||||
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?
|
||||
|
||||
<!-- Please place an [x] in the box to confirm. -->
|
||||
|
||||
- [ ] 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`?
|
||||
<details>
|
||||
<!-- Please provide output of the above command here. -->
|
||||
</details>
|
||||
|
||||
### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`?
|
||||
|
||||
<!-- Please provide output of the above command here. -->
|
||||
|
||||
43
.github/ISSUE_TEMPLATE/possible-bug.md
vendored
43
.github/ISSUE_TEMPLATE/possible-bug.md
vendored
@ -7,14 +7,45 @@ labels: triage
|
||||
|
||||
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
|
||||
|
||||
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?
|
||||
<!-- Please place an [x] in the box to confirm. -->
|
||||
|
||||
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?
|
||||
|
||||
<!-- Please place an [x] in the box to confirm. -->
|
||||
|
||||
- [ ] 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`?
|
||||
|
||||
<!-- Please provide output of the above command here. -->
|
||||
|
||||
### What are the steps to reproduce?
|
||||
|
||||
<!-- Please enter steps to reproduce here. -->
|
||||
|
||||
### What is the expected behaviour?
|
||||
|
||||
<!-- Please enter the expected behaviour here. -->
|
||||
|
||||
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem
|
||||
|
||||
<!-- Please provide either formatted code or a link to a repo/gist that allows someone else to reproduce here. -->
|
||||
|
||||
### Please provide sample image(s) that help explain this problem
|
||||
|
||||
<!-- Please provide links to one or more images here. -->
|
||||
|
||||
18
.github/ISSUE_TEMPLATE/question.md
vendored
18
.github/ISSUE_TEMPLATE/question.md
vendored
@ -7,10 +7,20 @@ labels: question
|
||||
|
||||
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
|
||||
|
||||
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?
|
||||
<!-- Please provide context here. -->
|
||||
|
||||
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 demonstrate your research here. -->
|
||||
|
||||
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this question
|
||||
|
||||
<!-- Please provide either formatted code or a link to a repo/gist that helps someone else understand here. -->
|
||||
|
||||
### Please provide sample image(s) that help explain this question
|
||||
|
||||
<!-- Please provide links to one or more images here. -->
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user