Skip to content

Commit ee6f3d2

Browse files
authored
Update bug.yml
1 parent 0a328c4 commit ee6f3d2

File tree

1 file changed

+16
-23
lines changed

1 file changed

+16
-23
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
Thanks for taking the time to submit a bug report!
8+
Thanks for taking the time to submit a bug report! 😃
99
* Be sure to answer **all** of the questions below.
1010
* Provide lots of detail. Too much info is better than not enough.
1111
* If we can't reproduce the issue, we can't fix it.
1212
13-
Please help us help you by reading the following posts before submitting your report! 😃
14-
* [www.sscce.org](http://www.sscce.org/)
15-
* [Smart Questions](http://catb.org/~esr/faqs/smart-questions.html)
13+
If you've never created an issue on GitHub before, you might find these links helpful:
1614
* [45 GitHub Issues Dos and Don'ts](https://davidwalsh.name/45-github-issues-dos-donts)
15+
* [Smart Questions](http://catb.org/~esr/faqs/smart-questions.html)
1716
1817
You can read [MAINTAINERSHIP.md](https://github.com/Hopding/pdf-lib/blob/master/docs/MAINTAINERSHIP.md) to learn more about how this repo is maintained.
1918
- type: textarea
@@ -22,12 +21,6 @@ body:
2221
description: Clearly describe what you were trying to do when you found this bug.
2322
validations:
2423
required: true
25-
- type: textarea
26-
attributes:
27-
label: Why were you trying to do this?
28-
description: Explain why you were trying to do this.
29-
validations:
30-
required: true
3124
- type: textarea
3225
attributes:
3326
label: How did you attempt to do it?
@@ -50,17 +43,21 @@ body:
5043
attributes:
5144
label: How can we reproduce the issue?
5245
description: |
53-
Type out a list of specific steps we can take to reproduce the bug you've found. Your response must include both prose and code snippets. You must attach (or provides links to) any PDFs, images, or other files necessary to complete the steps.
54-
55-
> If you are unable to share certain files (e.g. confidential PDFs), then state this in your response. Be prepared to share the files privately (e.g. via email). If you are unable to do this then we probably can't fix the issue.
56-
57-
Your response should include **complete**, **executable** code, ideally in the form of a git repo. Read [www.sscce.org](http://www.sscce.org/) to learn how to create a Short, Self Contained, Correct (Compilable) Example.
46+
Provide **complete**, **executable** code that can be used to reproduce the bug (e.g. a git repo, ZIP file, or JSFiddle). You must attach (or provides links to) any PDFs, images, or other files necessary to run your code.
5847
59-
Please also read [Smart Questions](http://catb.org/~esr/faqs/smart-questions.html) and [45 GitHub Issues Dos and Don'ts](https://davidwalsh.name/45-github-issues-dos-donts).
48+
Your code example should be a [SSCCE](http://www.sscce.org/):
49+
- Short (Small) - Don't include code that is irrelevant or unnecessary.
50+
- Self Contained - Ensure everything is included, ready to go.
51+
- Correct - No additional code or changes are needed to copy, paste, and execute it.
52+
- Example - Displays the problem you are reporting.
6053
61-
> We understand this is a nontrivial amount of reading. However, it's important that you create a well-defined report in order to reduce the demand placed on maintainers trying to help you. We want to make this a pleasant, efficient process for both you and us! 💖
54+
Please also type out a list of specific steps we can take to run your code and reproduce the issue. Depending on what you're reporting, this might be simple as running a JSFiddle or downloading a ZIP file and executing `node index.js`. Some issues will require more instructions.
6255
63-
If your response only includes incomplete code or doesn't clearly state how to execute the code you've provided, your report will be closed without comment.
56+
> If you are unable to share certain files (e.g. confidential PDFs), then state this in your response. Be prepared to share the files privately (e.g. via email). If you are unable to do this then we probably can't fix the issue.
57+
58+
⚠️ If your response includes incomplete code or doesn't clearly state how to execute the code you've provided, your report will be closed without comment.
59+
60+
Thank you for taking the time to create a well-defined report. This helps reduce the demand placed on maintainers trying to help you. We want to make this a pleasant, efficient process for both you and us! 💖
6461
validations:
6562
required: true
6663
- type: input
@@ -85,13 +82,9 @@ body:
8582
attributes:
8683
label: Required Reading
8784
options:
88-
- label: I have read [www.sscce.org](http://www.sscce.org/).
89-
required: true
9085
- label: My report includes a Short, Self Contained, Correct (Compilable) Example.
9186
required: true
92-
- label: I have read [Smart Questions](http://catb.org/~esr/faqs/smart-questions.html).
93-
required: true
94-
- label: I have read [45 GitHub Issues Dos and Don'ts](https://davidwalsh.name/45-github-issues-dos-donts).
87+
- label: I have attached all PDFs, images, and fonts needed to run my SSCCE.
9588
required: true
9689
- type: textarea
9790
attributes:

0 commit comments

Comments
 (0)