Skip to content

Commit 8056ce0

Browse files
Merge pull request valkey-io#616 from aws/alexander-shabanov-bug-report-template
Create bug-report.yml
2 parents 3b4922c + a78e01c commit 8056ce0

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(topic): (short issue description)"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
60+
validations:
61+
required: false
62+
63+
- type: input
64+
id: operating-system
65+
attributes:
66+
label: OS
67+
validations:
68+
required: true
69+
70+
- type: dropdown
71+
id: language
72+
attributes:
73+
label: Language
74+
multiple: true
75+
options:
76+
- TypeScript
77+
- Python
78+
validations:
79+
required: true
80+
81+
- type: input
82+
id: language-version
83+
attributes:
84+
label: Language Version
85+
description: E.g. TypeScript (5.2.2) | Python (3.9)
86+
validations:
87+
required: false
88+
89+
- type: textarea
90+
id: other
91+
attributes:
92+
label: Other information
93+
description: |
94+
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, etc
95+
validations:
96+
required: false

0 commit comments

Comments
 (0)