From 28a7adbffea1bedee750362357b8a64eca65e149 Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Tue, 11 Oct 2022 09:41:10 -0800 Subject: [PATCH] update issue tracker templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 36 +++++++++++++ 3 files changed, 95 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**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. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2c34453 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +--- +name: "Bug Report" +description: "submit a bug report for the current release" +body: + - type: checkboxes + id: checks + attributes: + label: First Check + description: Please confirm and check all the following options. + options: + - label: This is not a feature request + required: true + - label: I added a very descriptive title to this issue. + required: true + - label: I used the GitHub search to find a similar issue and didn't find it. + required: true + - label: I searched the documentation, with the integrated search. + required: true + - label: I already read the docs and didn't find an answer. + required: true + - type: input + id: homebox-version + attributes: + label: Homebox Version + validations: + required: true + - type: textarea + id: description + attributes: + label: What is the issue you are experiencing? + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: How can the maintainer reproduce the issue? + placeholder: A clear step-by-step guide on how to reproduce the issue. + validations: + required: true + - type: dropdown + id: os + attributes: + label: Deployment + description: What Deployment system are you using? + multiple: true + options: + - Docker (Linux) + - Docker (Windows) + - Docker (Synology) + - Unraid + - Other + validations: + required: true + - type: textarea + id: os-details + attributes: + label: Deployment Details + description: You can add more details about your operating system here, in particular if you chose "Other". If you are experiencing issues with deployment, please provide your docker-compose or docker commands diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8a15b34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +--- +name: "Feature Request" +description: "submit a feature request for the current release" +body: + - type: textarea + id: problem-statement + attributes: + label: What is the problem you are trying to solve with this feature? + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + - type: textarea + id: feature-solution + attributes: + label: What is the solution you are proposing? + placeholder: A clear and concise description of what you want to happen. + - type: textarea + id: feature-alternatives + attributes: + label: What alternatives have you considered? + placeholder: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: feature-details + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the feature request here. + - type: checkboxes + id: checks + attributes: + label: Contributions + description: Please confirm the following + options: + - label: I have searched through existing issues and feature requests to see if my idea has already been proposed. + required: true + - label: If this feature is accepted, I would be willing to help implement and maintain this feature. + required: false + - label: If this feature is accepted, I'm willing to sponsor the development of this feature. + required: false