Improve bug form
This commit is contained in:
parent
f15699a4f4
commit
174618cf6b
|
|
@ -13,8 +13,11 @@ body:
|
||||||
id: package
|
id: package
|
||||||
attributes:
|
attributes:
|
||||||
label: Installation method
|
label: Installation method
|
||||||
description: Which package are you using?
|
description: |
|
||||||
|
Some packages are maintained by the community, rather than by the Sherlock Project.
|
||||||
|
Knowing which packages are affected helps us diagnose package-specific bugs.
|
||||||
options:
|
options:
|
||||||
|
- Select one
|
||||||
- PyPI (via pip)
|
- PyPI (via pip)
|
||||||
- Homebrew
|
- Homebrew
|
||||||
- Docker
|
- Docker
|
||||||
|
|
@ -27,9 +30,16 @@ body:
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Description
|
label: Description
|
||||||
description: Describe the bug you are experiencing
|
description: |
|
||||||
|
Detailed descriptions that help contributors understand and reproduce your bug are much more likely to lead to a fix.
|
||||||
|
Please include the following information:
|
||||||
|
- What you were trying to do
|
||||||
|
- What you expected to happen
|
||||||
|
- What actually happened
|
||||||
|
- Any additional information that might help us diagnose the problem
|
||||||
placeholder: |
|
placeholder: |
|
||||||
When doing {action}, {expected result} is what I expected to happen, but {actual result} happened instead.
|
When doing {action}, the expected result should be {expected result}.
|
||||||
|
When doing {action}, however, the actual result was {actual result}.
|
||||||
This is undesirable because {reason}.
|
This is undesirable because {reason}.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
@ -37,7 +47,7 @@ body:
|
||||||
id: steps-to-reproduce
|
id: steps-to-reproduce
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce
|
label: Steps to reproduce
|
||||||
description: Write a step by step list that will allow us to reproduce this bug
|
description: Write a step by step list that will allow us to reproduce this bug.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
1. Do something
|
1. Do something
|
||||||
2. Then do something else
|
2. Then do something else
|
||||||
|
|
@ -47,7 +57,7 @@ body:
|
||||||
id: additional-info
|
id: additional-info
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional information
|
label: Additional information
|
||||||
description: If you have some additional information, please write it here
|
description: If you have some additional information, please write it here.
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue