From 6901747a26a85bb41785c0f48fa951fcec6a9011 Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Sun, 6 Aug 2023 09:35:38 -0800 Subject: [PATCH] chore: rework issue templates (#2481) * rewrok issue templates * fix feature request links * feature-template --- .../DISCUSSION_TEMPLATE/feature-request.yaml | 45 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug-report.yaml | 42 ++++++++++----- .github/ISSUE_TEMPLATE/config.yml | 4 +- .../ISSUE_TEMPLATE/recipe-scraper-bug.yaml | 53 +++++++++++++++++++ .../{v1-task.yaml => task.yaml} | 0 .github/ISSUE_TEMPLATE/v1-bug-report.yaml | 47 ---------------- 6 files changed, 128 insertions(+), 63 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/recipe-scraper-bug.yaml rename .github/ISSUE_TEMPLATE/{v1-task.yaml => task.yaml} (100%) delete mode 100644 .github/ISSUE_TEMPLATE/v1-bug-report.yaml diff --git a/.github/DISCUSSION_TEMPLATE/feature-request.yaml b/.github/DISCUSSION_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000000..706431bc2400 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/feature-request.yaml @@ -0,0 +1,45 @@ +--- +name: Feature Request +description: "Submit a Feature Request" +title: "YOUR TITLE" +body: + - type: checkboxes + id: checks + attributes: + label: First Check + description: | + Please confirm and check all the following prior to submission. If you do not do this, your + issue may be closed. + options: + - label: I used the GitHub search to find a similar requests and didn't find it. + required: true + - label: Checked the [tasks taged](https://github.com/hay-kot/mealie/issues?q=is%3Aissue+is%3Aopen+label%3Atask+) issues and verified my feature is not covered + required: true + - label: Checked the [tasks taged](https://github.com/hay-kot/mealie/issues?q=is%3Aissue+is%3Aopen+label%3Atask+) issues and verified my feature is not covered + required: true + - type: textfield + id: problem + attributes: + label: Please provide a concise description of the problem that would be addressed by this feature. + validations: + required: true + - type: textfield + id: solution + attributes: + label: Please provide a concise description of the feature that would resolve your issue. + validations: + required: true + - type: textfield + id: considerations + attributes: + label: Please consider and list out some caveats or tradeoffs made in your design decision + validations: + required: true + - type: checkboxes + id: checks + attributes: + label: Additional Information + options: + - label: If this is accepted I'm willing to submit a PR to provide this feature + - label: If this is accepted I'm willing to help maintain this feature + - label: I'm willing to sponsor/pay a developer to do this work diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 456d5b7b3a47..34da7d4c6685 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,12 +1,16 @@ --- -name: "[v0.5.x] Bug Report" -description: "submit a bug report for the current release" +name: Bug Report +description: "Submit a bug for the latest version of Mealie" +title: "[BUG] - YOUR TITLE" +labels: ["bug", "triage"] body: - type: checkboxes id: checks attributes: label: First Check - description: Please confirm and check all the following options. + description: | + Please confirm and check all the following prior to submission. If you do not do this, your + issue may be closed. options: - label: This is not a feature request required: true @@ -18,8 +22,8 @@ body: required: true - label: I already read the docs and didn't find an answer. required: true - - label: I have checked for existing issues that have been resolved in v1-beta - required: true + - label: This issue can be replicated on the demo site (https://demo.mealie.io/) + required: false - type: textarea id: description attributes: @@ -27,6 +31,23 @@ body: placeholder: A clear and concise description of what the bug is. validations: required: true + - type: textarea + id: description + attributes: + label: Steps to Reproduce + placeholder: 1) ... 2) ... 3) ... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Please provide relevent logs + validations: + required: true + - type: textarea + id: version + attributes: + label: Mealie Version - type: dropdown id: os attributes: @@ -42,13 +63,6 @@ body: validations: required: true - type: textarea - id: os-details + id: other 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 - - type: input - id: mealie-version - attributes: - label: Mealie Version - validations: - required: true + label: Additional Deployment Details diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 52ffc42c6d3e..844c8ff7c493 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - name: Feature Requests - url: https://github.com/hay-kot/mealie/issues/122 - about: Please add any Feature Requests here. + url: https://github.com/hay-kot/mealie/issues/317 + about: Please add any Feature Requests as a Github Discussion using the for in this issue. diff --git a/.github/ISSUE_TEMPLATE/recipe-scraper-bug.yaml b/.github/ISSUE_TEMPLATE/recipe-scraper-bug.yaml new file mode 100644 index 000000000000..a15a02d1357e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/recipe-scraper-bug.yaml @@ -0,0 +1,53 @@ +--- +name: Error Scraping Recipe +description: "Submit a bug or issues related to scraping recipes" +title: "[SCRAPER] - YOUR TITLE" +labels: ["bug", "triage", "scraper"] +body: + - type: checkboxes + id: checks + attributes: + label: First Check + description: | + Please confirm and check all the following prior to submission. If you do not do this, your + issue may be closed. + options: + - label: I used the GitHub search to find a similar issue and didn't find it. + required: true + - label: | + I have verified that this issue _is not_ related to the underlying library + [hhyrsev/recipe-scrapers](https://github.com/hhursev/recipe-scrapers) by **1)** checking + the [debugger](https://demo.mealie.io/recipe/create/debug) and data is returned, **2)** + verifying that there _are_ errors in the log related to application level code, or + **3)** verified that the site provides recipe data, or is otherwise supported by + [hhyrsev/recipe-scrapers](https://github.com/hhursev/recipe-scrapers) + required: true + - label: This issue can be replicated on the demo site (https://demo.mealie.io/) + required: false + - type: textfield + id: urls + attributes: + label: Please provide 1-5 example URLs that are having errors + validations: + required: true + - type: textfield + id: logs + attributes: + label: | + Please provide your logs for the Mealie container `docker logs > mealie.logs` + 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 diff --git a/.github/ISSUE_TEMPLATE/v1-task.yaml b/.github/ISSUE_TEMPLATE/task.yaml similarity index 100% rename from .github/ISSUE_TEMPLATE/v1-task.yaml rename to .github/ISSUE_TEMPLATE/task.yaml diff --git a/.github/ISSUE_TEMPLATE/v1-bug-report.yaml b/.github/ISSUE_TEMPLATE/v1-bug-report.yaml deleted file mode 100644 index 3a4c490bc431..000000000000 --- a/.github/ISSUE_TEMPLATE/v1-bug-report.yaml +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: v1.0.0b Bug Report -description: "submit a bug report for the v1 beta" -title: "[v1.0.0b] - YOUR TITLE" -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 Mealie documentation, with the integrated search. - required: true - - label: I already read the docs and didn't find an answer. - 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: 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