Skip to content

Commit eba5e8d

Browse files
committed
add github bug template
1 parent f5d8446 commit eba5e8d

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Submit a bug report for TwitchIO
4+
title: "[Bug]: "
5+
labels: ["unconfirmed bug", "needs verification"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
### Thank you for using TwitchIO!
11+
12+
If you'd rather use [our Discord server](https://discord.gg/RAKc3HF) for support than a Github issue please feel free to join
13+
and talk to use there instead!
14+
Feel free to discuss in [#help](https://discord.com/channels/490948346773635102/490951172673372195) or make a thread in our [#help-forum](https://canary.discord.com/channels/490948346773635102/1006716547223519293).
15+
- type: textarea
16+
id: what-happened
17+
attributes:
18+
label: "What actually happened?"
19+
description: "Please enter details about the issue, including tracebacks if applicable (in codeblocks)."
20+
placeholder: "My Bot will not start!"
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: expected-outcome
25+
attributes:
26+
label: "What did you expect to happen instead?"
27+
description: "Please enter what you hoped or expected to happen instead of the issue that occurred."
28+
placeholder: "My Bot started successfully!"
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: mre
33+
attributes:
34+
label: "Minimum reproducible example:"
35+
description: "Please provide the minimum necessary code to reproduce your issue, if relevant."
36+
render: python
37+
- type: textarea
38+
id: repro-steps
39+
attributes:
40+
label: "Steps to reproduce the problem"
41+
description: "It may not be obvious how to *cause* the issue, so please explain below."
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: logs
46+
attributes:
47+
label: "Additional logs:"
48+
description: "If there is any logging output that may be relevant, please add it here."
49+
- type: textarea
50+
id: environment-details
51+
attributes:
52+
label: "System and Environment information"
53+
description: "Please put the output of `python -m twitchio --version` here:"
54+
validations:
55+
required: true

0 commit comments

Comments
 (0)