From eb2ead393a8bb75f321a19204f712ce7032358ba Mon Sep 17 00:00:00 2001 From: Vermium Sifell Date: Sun, 12 Jun 2022 13:09:00 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=B8=20better=20issue=20templates?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ----------- .github/ISSUE_TEMPLATE/bug_report.yaml | 60 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/command_request.yaml | 48 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- 4 files changed, 108 insertions(+), 52 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/command_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6debbd7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: "bug" -assignees: "VermiumSifell" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - -- Commit: [git rev-parse HEAD] -- Branch: [git branch --show-current] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..dab3c2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,60 @@ +name: 🐞 Bug +description: File a bug/issue +title: "[BUG]: " +labels: ["bug"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. Run '...' + 3. See error... + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Node**: 13.14.0 + - **npm**: 7.6.3 + - **xyter**: 7d02cf9 + value: | + - OS: `lsb_release -d` + - Node: `node -v` + - npm: `npm -v` + - xyter: `git rev-parse --short HEAD` + render: markdown + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/command_request.yaml b/.github/ISSUE_TEMPLATE/command_request.yaml new file mode 100644 index 0000000..e6d047c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/command_request.yaml @@ -0,0 +1,48 @@ +name: 🤖 Request a new command +description: Suggest an command for this project +title: "[New Command]: / [command_group] " +labels: ["enhancement", "new-command"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! We will use `/manage credits give` as an example for our placeholders. + - type: input + id: category + attributes: + label: Category + description: Where should we put this command? + placeholder: ex. manage + validations: + required: true + - type: input + id: group + attributes: + label: Group + description: Does this command belong to this group? + placeholder: ex. credits + - type: input + id: command + attributes: + label: Command + description: What should we call this command? + placeholder: ex. give + validations: + required: true + - type: textarea + id: description + attributes: + label: What should the command do? + description: Please tell us your concept, how it should work, and if there should be any additional features. + placeholder: "I would like to have a command to give users credits, that would make it easier for me to administrate credits! I would like it to add a specified amount of credits to specified user, without taking credits from the executer. Command should require Manage Guild permission. When successful, it should return something like: Added credits to !" + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 36014cd..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'enhancement' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.