Skip to content

Commit 174618c

Browse files
committed
Improve bug form
1 parent f15699a commit 174618c

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ body:
1313
id: package
1414
attributes:
1515
label: Installation method
16-
description: Which package are you using?
16+
description: |
17+
Some packages are maintained by the community, rather than by the Sherlock Project.
18+
Knowing which packages are affected helps us diagnose package-specific bugs.
1719
options:
20+
- Select one
1821
- PyPI (via pip)
1922
- Homebrew
2023
- Docker
@@ -27,17 +30,24 @@ body:
2730
id: description
2831
attributes:
2932
label: Description
30-
description: Describe the bug you are experiencing
33+
description: |
34+
Detailed descriptions that help contributors understand and reproduce your bug are much more likely to lead to a fix.
35+
Please include the following information:
36+
- What you were trying to do
37+
- What you expected to happen
38+
- What actually happened
39+
- Any additional information that might help us diagnose the problem
3140
placeholder: |
32-
When doing {action}, {expected result} is what I expected to happen, but {actual result} happened instead.
41+
When doing {action}, the expected result should be {expected result}.
42+
When doing {action}, however, the actual result was {actual result}.
3343
This is undesirable because {reason}.
3444
validations:
3545
required: true
3646
- type: textarea
3747
id: steps-to-reproduce
3848
attributes:
3949
label: Steps to reproduce
40-
description: Write a step by step list that will allow us to reproduce this bug
50+
description: Write a step by step list that will allow us to reproduce this bug.
4151
placeholder: |
4252
1. Do something
4353
2. Then do something else
@@ -47,7 +57,7 @@ body:
4757
id: additional-info
4858
attributes:
4959
label: Additional information
50-
description: If you have some additional information, please write it here
60+
description: If you have some additional information, please write it here.
5161
validations:
5262
required: false
5363
- type: checkboxes

0 commit comments

Comments
 (0)