Skip to content

Commit 134370a

Browse files
Create issue templates for bugs and feature requests (#497)
* add github bug template * add further templates * title case * fix comments
1 parent f5d8446 commit 134370a

File tree

3 files changed

+93
-0
lines changed

3 files changed

+93
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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: textarea
8+
id: what-happened
9+
attributes:
10+
label: "What actually happened?"
11+
description: "Please enter details about the issue, including tracebacks if applicable (in codeblocks)."
12+
placeholder: "My Bot will not start!"
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected-outcome
17+
attributes:
18+
label: "What did you expect to happen instead?"
19+
description: "Please enter what you hoped or expected to happen instead of the issue that occurred."
20+
placeholder: "My Bot started successfully!"
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: mre
25+
attributes:
26+
label: "Minimum reproducible example:"
27+
description: "Please provide the minimum necessary code to reproduce your issue, if relevant."
28+
render: python
29+
- type: textarea
30+
id: repro-steps
31+
attributes:
32+
label: "Steps to reproduce the problem"
33+
description: "It may not be obvious how to *cause* the issue, so please explain below."
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: logs
38+
attributes:
39+
label: "Additional logs:"
40+
description: "If there is any logging output that may be relevant, please add it here."
41+
- type: textarea
42+
id: environment-details
43+
attributes:
44+
label: "System and Environment information"
45+
description: "Please put the output of `python -m twitchio --version` here:"
46+
validations:
47+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: TwitchIO Documentation
4+
url: https://twitchio.dev/en/latest/index.html
5+
about: Official TwitchIO documentation - please check here before opening an issue.
6+
- name: Discord
7+
url: https://discord.gg/RAKc3HF
8+
about: Join our Discord community to chat or receive help, or get in touch with the maintainers.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "Feature Request"
2+
description: Create an issue for a new feature request
3+
title: "Enhancement: <title>"
4+
labels:
5+
- "Enhancement"
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: "Summary"
11+
description: Provide a brief summary of your feature request
12+
placeholder: Describe in a few lines your feature request
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: basic_example
17+
attributes:
18+
label: "Basic Examples"
19+
description: Indicate here some basic examples of your feature.
20+
placeholder: Provide some basic example of your feature request
21+
validations:
22+
required: false
23+
- type: textarea
24+
id: drawbacks
25+
attributes:
26+
label: "Drawbacks and Impact"
27+
description: What are the drawbacks or impacts of your feature request?
28+
placeholder: Describe any of the drawbacks or impacts of your feature request
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: unresolved_question
33+
attributes:
34+
label: "Unresolved questions"
35+
description: What, if any, unresolved questions do you have about your feature request?
36+
placeholder: Identify any unresolved issues.
37+
validations:
38+
required: false

0 commit comments

Comments
 (0)