Skip to content

Commit dc5f4dc

Browse files
committed
Issue templates: improve guidance, increase filtering
1 parent 735793b commit dc5f4dc

4 files changed

Lines changed: 92 additions & 20 deletions

File tree

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,24 @@ labels: enhancement
55

66
---
77

8-
What are you trying to achieve?
8+
## Feature request
99

10-
Have you searched for similar feature requests?
10+
### What are you trying to achieve?
1111

12-
What would you expect the API to look like?
12+
<!-- Please provide context here. -->
1313

14-
What alternatives have you considered?
14+
### When you searched for similar feature requests, what did you find that might be related?
1515

16-
Is there a sample image that helps explain?
16+
<!-- Please demonstrate your research here. -->
17+
18+
### What would you expect the API to look like?
19+
20+
<!-- Please provide your suggestions here. -->
21+
22+
### What alternatives have you considered?
23+
24+
<!-- Please provide your ideas here. -->
25+
26+
### Please provide sample image(s) that help explain this feature
27+
28+
<!-- Please provide links to one or more images here. -->

.github/ISSUE_TEMPLATE/installation.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,37 @@ labels: installation
77

88
<!-- Please try to answer as many of these questions as possible. -->
99

10-
Did you see the [documentation relating to installation](https://sharp.pixelplumbing.com/install)?
10+
## Possible install-time or require-time problem
1111

12-
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?
12+
<!-- Please place an [x] in the box to confirm. -->
1313

14-
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`?
14+
- [ ] I have read the [documentation relating to installation](https://sharp.pixelplumbing.com/install)?
15+
- [ ] 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.
16+
17+
### Are you using the latest version of sharp?
18+
19+
<!-- Please place an [x] in the box to confirm. -->
20+
21+
- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`.
22+
23+
If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.
24+
25+
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.
26+
27+
### Is this a problem with filesystem permissions?
1528

1629
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?
1730

1831
If you are using npm v7 or later, does the user running `npm install` own the directory it is run in?
1932

2033
If you are using the `ignore-scripts` feature of `npm`, have you tried with the `npm install --ignore-scripts=false` flag?
2134

22-
What is the complete output of running `npm install --verbose sharp`? Have you checked this output for useful error messages?
35+
### What is the complete output of running `npm install --verbose sharp`?
36+
37+
<details>
38+
<!-- Please provide output of the above command here. -->
39+
</details>
40+
41+
### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`?
2342

24-
What is the output of running `npx envinfo --binaries --system`?
43+
<!-- Please provide output of the above command here. -->

.github/ISSUE_TEMPLATE/possible-bug.md

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,45 @@ labels: triage
77

88
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
99

10-
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`?
10+
## Possible bug
1111

12-
What are the steps to reproduce?
12+
### Is this a possible bug in a feature of sharp, unrelated to installation?
1313

14-
What is the expected behaviour?
14+
<!-- Please place an [x] in the box to confirm. -->
1515

16-
Are you able to provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem?
16+
- [ ] Running `npm install sharp` completes without error.
17+
- [ ] Running `node -e "require('sharp')"` completes without error.
1718

18-
Are you able to provide a sample image that helps explain the problem?
19+
If you cannot confirm both of these, please open an
20+
[installation issue](https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md)
21+
instead.
1922

20-
What is the output of running `npx envinfo --binaries --system`?
23+
### Are you using the latest version of sharp?
24+
25+
<!-- Please place an [x] in the box to confirm. -->
26+
27+
- [ ] I am using the latest version of `sharp` as reported by `npm view sharp dist-tags.latest`.
28+
29+
If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.
30+
31+
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.
32+
33+
### What is the output of running `npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp`?
34+
35+
<!-- Please provide output of the above command here. -->
36+
37+
### What are the steps to reproduce?
38+
39+
<!-- Please enter steps to reproduce here. -->
40+
41+
### What is the expected behaviour?
42+
43+
<!-- Please enter the expected behaviour here. -->
44+
45+
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem
46+
47+
<!-- Please provide either formatted code or a link to a repo/gist that allows someone else to reproduce here. -->
48+
49+
### Please provide sample image(s) that help explain this problem
50+
51+
<!-- Please provide links to one or more images here. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,20 @@ labels: question
77

88
<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
99

10-
What are you trying to achieve?
10+
## Question about an existing feature
1111

12-
Have you searched for similar questions?
12+
### What are you trying to achieve?
1313

14-
Are you able to provide a minimal, standalone code sample that demonstrates this question?
14+
<!-- Please provide context here. -->
1515

16-
Are you able to provide a sample image that helps explain the question?
16+
### When you searched for similar issues, what did you find that might be related?
17+
18+
<!-- Please demonstrate your research here. -->
19+
20+
### Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this question
21+
22+
<!-- Please provide either formatted code or a link to a repo/gist that helps someone else understand here. -->
23+
24+
### Please provide sample image(s) that help explain this question
25+
26+
<!-- Please provide links to one or more images here. -->

0 commit comments

Comments
 (0)