mirror of
https://github.com/sherlock-project/sherlock
synced 2024-11-21 19:33:02 +00:00
Improve bug form
This commit is contained in:
parent
f15699a4f4
commit
174618cf6b
1 changed files with 15 additions and 5 deletions
20
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
20
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
|
@ -13,8 +13,11 @@ body:
|
|||
id: package
|
||||
attributes:
|
||||
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:
|
||||
- Select one
|
||||
- PyPI (via pip)
|
||||
- Homebrew
|
||||
- Docker
|
||||
|
@ -27,9 +30,16 @@ body:
|
|||
id: description
|
||||
attributes:
|
||||
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: |
|
||||
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}.
|
||||
validations:
|
||||
required: true
|
||||
|
@ -37,7 +47,7 @@ body:
|
|||
id: steps-to-reproduce
|
||||
attributes:
|
||||
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: |
|
||||
1. Do something
|
||||
2. Then do something else
|
||||
|
@ -47,7 +57,7 @@ body:
|
|||
id: additional-info
|
||||
attributes:
|
||||
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:
|
||||
required: false
|
||||
- type: checkboxes
|
||||
|
|
Loading…
Reference in a new issue