From 082106eb211060f673a21ce119c2d27e5f6abf48 Mon Sep 17 00:00:00 2001 From: Kowlin Date: Tue, 2 Feb 2021 00:35:16 +0100 Subject: [PATCH] Oh boy! more issue templates! (#4783) * Oh boy! more issue templates! * Add some descriptions to command_bug.yml * Update enhancements.yml to refer to "components" since one might want to request API enhancement * Update feature_request.yml * Update command_bug.yml * typo * I don't think this would cause any issue but I would rather not need another PR Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/command_bug.yml | 14 +++++-- .github/ISSUE_TEMPLATE/enhancements.yml | 23 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/other_bugs.yml | 42 ++++++++++++++++++++ 4 files changed, 120 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/enhancements.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/other_bugs.yml diff --git a/.github/ISSUE_TEMPLATE/command_bug.yml b/.github/ISSUE_TEMPLATE/command_bug.yml index deaf4dec1..d64c11957 100644 --- a/.github/ISSUE_TEMPLATE/command_bug.yml +++ b/.github/ISSUE_TEMPLATE/command_bug.yml @@ -7,10 +7,13 @@ issue_body: true inputs: - type: description attributes: - value: 'Thank you for taking the time to fill out an issue. This template is meant for any issues related to commands. If you require help with installing Red we ask that you join our Discord server over at https://discord.gg/red' + value: | + Thank you for taking the time to fill out an issue. This template is meant for any issues related to commands. + If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red) - type: input attributes: - label: "What version are you using?" + label: "What Red version are you using?" + placeholder: 3.4.5 required: true - type: dropdown attributes: @@ -48,16 +51,19 @@ inputs: required: true - type: textarea attributes: - label: "Expected behavior" - description: "What did you expect to happen?" + label: "What did you expect to happen?" required: true - type: textarea attributes: label: "What actually happened?" + description: | + A clear and concise description of what the bug is. + If the issue is visual in nature, consider posting a screenshot. required: true - type: textarea attributes: label: "How can we reproduce this error?" + description: "List of steps required to reproduce this error." value: | 1. 2. diff --git a/.github/ISSUE_TEMPLATE/enhancements.yml b/.github/ISSUE_TEMPLATE/enhancements.yml new file mode 100644 index 000000000..ad5b66823 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancements.yml @@ -0,0 +1,23 @@ +name: Enhancement proposal +about: For feature requests and improvements related to already existing functionality. +title: '' +labels: 'Type: Enhancement' +assignees: '' +issue_body: true +inputs: +- type: description + attributes: + value: | + Thank you for taking the time to fill out an issue. This template is meant for feature requests and improvements to already existing functionality. + If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red) +- type: input + attributes: + label: "What component of Red (cog, command, API) would you like to see improvements on?" + placeholder: Audio + required: true +- type: textfield + attributes: + label: "Descrive the enhancement you're suggesting." + required: true + description: | + Feel free to describe in as much detail as you wish. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..11ae4a648 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: Feature request +about: For feature requests regarding Red itself. +title: '' +labels: 'Type: Feature' +assignees: '' +issue_body: true +inputs: +- type: description + attributes: + value: | + Thank you for taking the time to fill out an issue, this template is meant for any feature suggestions. + If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red) +- type: multi_select + attributes: + label: "Type of feature request" + description: "What type of feature would you like to request?" + required: true + choices: + - API functionality + - Cog + - Command + - Other +- type: textarea + attributes: + label: "Description of the feature you're suggesting" + description: | + Feel free to describe in as much detail as you wish. + + If you are requesting API functionality: + - Describe what it should do + - Note whether it is to extend existing functionality or introduce new functionality + + If you are requesting a cog to be included in core: + - Describe the functionality in as much detail as possible + - Include the command structure, if possible + - Please note that unless it's something that should be core functionality, + we reserve the right to reject your suggestion and point you to our cog + board to request it for a third-party cog + + If you are requesting a command: + - Include what cog it should be in and a name for the command + - Describe the intended functionality for the command + - Note any restrictions on who can use the command or where it can be used + required: true + diff --git a/.github/ISSUE_TEMPLATE/other_bugs.yml b/.github/ISSUE_TEMPLATE/other_bugs.yml new file mode 100644 index 000000000..d09016ecc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_bugs.yml @@ -0,0 +1,42 @@ +name: Bug report +about: "For bugs that don't involve a command." +title: '' +labels: 'Type: Bug' +assignees: '' +issue_body: true +inputs: +- type: description + attributes: + value: | + Thank you for taking the time to fill out an issue. This template is meant for any issues not related to any existing command. + If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red) +- type: input + attributes: + label: "What Red version are you using?" + placeholder: 3.4.5 + required: true +- type: textarea + attributes: + label: "What were you trying to do?" + required: true +- type: textarea + attributes: + label: "What did you expect to happen?" + required: true +- type: textarea + attributes: + label: "What actually happened?" + description: | + If the issue is visual in nature, consider posting a screenshot. + required: true +- type: textarea + attributes: + label: "How can we reproduce this error?" + description: | + List of steps required to reproduce the error. If the bug is code related, a minimal code example that reproduces the problem would be a big help. + value: | + 1. + 2. + 3. + ... + required: true