From eba5e8da9b51e3038014fa76d60dbbc7e5f40cd4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Thu, 15 May 2025 14:40:07 +0100 Subject: [PATCH 1/4] add github bug template --- .github/ISSUE_TEMPLATE/bug.yml | 55 ++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..c1a784d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,55 @@ +--- +name: 🐛 Bug Report +description: Submit a bug report for TwitchIO +title: "[Bug]: " +labels: ["unconfirmed bug", "needs verification"] +body: + - type: markdown + attributes: + value: | + ### Thank you for using TwitchIO! + + If you'd rather use [our Discord server](https://discord.gg/RAKc3HF) for support than a Github issue please feel free to join + and talk to use there instead! + 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). + - 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 From cf148f4fc290a669591bf08f75969c97708fe1a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Thu, 15 May 2025 22:05:38 +0100 Subject: [PATCH 2/4] add further templates --- .github/ISSUE_TEMPLATE/config.yml | 8 +++++ .github/ISSUE_TEMPLATE/feature_request.yml | 38 ++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6e24011f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d465a813 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: "Feature Request" +description: Create an issue for a new feature request +title: "Enhancement: " +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 Example" + 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 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 From 9ef45db7b5b1eaf381e2294d4f0958f0ee44f57f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= <umbra@abstractumbra.dev> Date: Thu, 15 May 2025 22:07:08 +0100 Subject: [PATCH 3/4] title case --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c1a784d5..45f4d6a9 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -2,7 +2,7 @@ name: 🐛 Bug Report description: Submit a bug report for TwitchIO title: "[Bug]: " -labels: ["unconfirmed bug", "needs verification"] +labels: ["Unconfirmed Bug", "Needs Verification"] body: - type: markdown attributes: From 62d6929f46135da601f344009264b22cd3862a6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= <umbra@abstractumbra.dev> Date: Fri, 16 May 2025 09:45:29 +0100 Subject: [PATCH 4/4] fix comments --- .github/ISSUE_TEMPLATE/bug.yml | 8 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 4 ++-- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 45f4d6a9..0758ca7d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -4,14 +4,6 @@ description: Submit a bug report for TwitchIO title: "[Bug]: " labels: ["Unconfirmed Bug", "Needs Verification"] body: - - type: markdown - attributes: - value: | - ### Thank you for using TwitchIO! - - If you'd rather use [our Discord server](https://discord.gg/RAKc3HF) for support than a Github issue please feel free to join - and talk to use there instead! - 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). - type: textarea id: what-happened attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d465a813..a9c3c6c5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -15,7 +15,7 @@ body: - type: textarea id: basic_example attributes: - label: "Basic Example" + label: "Basic Examples" description: Indicate here some basic examples of your feature. placeholder: Provide some basic example of your feature request validations: @@ -25,7 +25,7 @@ body: attributes: label: "Drawbacks and Impact" description: What are the drawbacks or impacts of your feature request? - placeholder: Describe any 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