Skip to content

Create issue templates for bugs and feature requests #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: 🐛 Bug Report
description: Submit a bug report for TwitchIO
title: "[Bug]: "
labels: ["Unconfirmed Bug", "Needs Verification"]
body:
- type: textarea
id: what-happened
attributes:
label: "What actually happened?"
description: "Please enter details about the issue, including tracebacks if applicable (in codeblocks)."
placeholder: "My Bot will not start!"
validations:
required: true
- type: textarea
id: expected-outcome
attributes:
label: "What did you expect to happen instead?"
description: "Please enter what you hoped or expected to happen instead of the issue that occurred."
placeholder: "My Bot started successfully!"
validations:
required: true
- type: textarea
id: mre
attributes:
label: "Minimum reproducible example:"
description: "Please provide the minimum necessary code to reproduce your issue, if relevant."
render: python
- type: textarea
id: repro-steps
attributes:
label: "Steps to reproduce the problem"
description: "It may not be obvious how to *cause* the issue, so please explain below."
validations:
required: true
- type: textarea
id: logs
attributes:
label: "Additional logs:"
description: "If there is any logging output that may be relevant, please add it here."
- type: textarea
id: environment-details
attributes:
label: "System and Environment information"
description: "Please put the output of `python -m twitchio --version` here:"
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: TwitchIO Documentation
url: https://twitchio.dev/en/latest/index.html
about: Official TwitchIO documentation - please check here before opening an issue.
- name: Discord
url: https://discord.gg/RAKc3HF
about: Join our Discord community to chat or receive help, or get in touch with the maintainers.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "Feature Request"
description: Create an issue for a new feature request
title: "Enhancement: <title>"
labels:
- "Enhancement"
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief summary of your feature request
placeholder: Describe in a few lines your feature request
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Examples"
description: Indicate here some basic examples of your feature.
placeholder: Provide some basic example of your feature request
validations:
required: false
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks and Impact"
description: What are the drawbacks or impacts of your feature request?
placeholder: Describe any of the drawbacks or impacts of your feature request
validations:
required: false
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What, if any, unresolved questions do you have about your feature request?
placeholder: Identify any unresolved issues.
validations:
required: false