Skip to content

Commit 0b194f9

Browse files
authored
Update bug report template (#6857)
1 parent af5211a commit 0b194f9

File tree

1 file changed

+49
-22
lines changed

1 file changed

+49
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,21 @@ name: Bug Report
22
description: Report a bug to help us improve.
33
labels: [🐛 bug]
44
body:
5-
- type: checkboxes
5+
- type: markdown
66
attributes:
7-
label: Is there an existing issue for this?
8-
description: Please search to see if an issue already exists for the issue you encountered. [Github Issue Tracker](https://github.com/ChilliCream/graphql-platform/issues)
9-
options:
10-
- label: I have searched the existing issues
11-
required: true
7+
value: |
8+
**Before you start...**
9+
10+
This form is only for submitting bug reports. If you have a usage question
11+
or are unsure if this is really a bug, make sure to:
12+
13+
- Read the [documentation](https://chillicream.com/docs)
14+
- Ask on [Slack](https://slack.chillicream.com/)
15+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/hotchocolate)
16+
17+
Also try to search for your issue – it may have already been answered or even fixed in the main branch.
18+
However, if you find that an old, closed issue still persists in the latest version,
19+
you should open a new issue using the form below, instead of commenting on the old issue.
1220
- type: dropdown
1321
id: product
1422
attributes:
@@ -21,21 +29,47 @@ body:
2129
- Green Donut
2230
validations:
2331
required: true
24-
- type: textarea
25-
id: description
32+
- type: input
33+
id: version
34+
attributes:
35+
label: Version
36+
description: What version of the selected product are you running?
37+
placeholder: "12.0.0"
38+
validations:
39+
required: true
40+
- type: input
41+
id: reproduction-url
2642
attributes:
27-
label: Describe the bug
28-
description: Also tell us, what did you expect to happen?
43+
label: Link to minimal reproduction
44+
description: |
45+
Add the URL to a public Git repository or ZIP file.
46+
47+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed
48+
to show the bug.
49+
50+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
51+
placeholder: Reproduction URL
2952
validations:
3053
required: true
3154
- type: textarea
3255
id: steps-to-reproduce
3356
attributes:
3457
label: Steps to reproduce
3558
description: |
36-
A list of steps that can be followed to recreate the bug.
37-
If it cannot be described in simple steps, create a GitHub repository with code that clearly showcases the described bug. Include a link to the repository in the box below.
38-
value: "1. "
59+
What do we need to do after opening your reproduction in order to make the bug happen?
60+
Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner.
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: expected
65+
attributes:
66+
label: What is expected?
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: actual
71+
attributes:
72+
label: What is actually happening?
3973
validations:
4074
required: true
4175
- type: textarea
@@ -47,18 +81,11 @@ body:
4781
This will be automatically formatted into code, so no need for backticks.
4882
render: shell
4983
- type: textarea
84+
id: additional-context
5085
attributes:
51-
label: Additional Context?
86+
label: Additional context
5287
description: |
5388
Please add any other contextual information about the problem, that might be relevant and help explain the issue you're facing.
5489
You can attach images or log files by clicking this area to highlight it and then dragging files in.
5590
validations:
5691
required: false
57-
- type: input
58-
id: version
59-
attributes:
60-
label: Version
61-
description: What version of the selected product are you running?
62-
placeholder: "12.0.0"
63-
validations:
64-
required: true

0 commit comments

Comments
 (0)