13
13
id : package
14
14
attributes :
15
15
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.
17
19
options :
20
+ - Select one
18
21
- PyPI (via pip)
19
22
- Homebrew
20
23
- Docker
@@ -27,17 +30,24 @@ body:
27
30
id : description
28
31
attributes :
29
32
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
31
40
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}.
33
43
This is undesirable because {reason}.
34
44
validations :
35
45
required : true
36
46
- type : textarea
37
47
id : steps-to-reproduce
38
48
attributes :
39
49
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.
41
51
placeholder : |
42
52
1. Do something
43
53
2. Then do something else
47
57
id : additional-info
48
58
attributes :
49
59
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.
51
61
validations :
52
62
required : false
53
63
- type : checkboxes
0 commit comments