From 37e3b93193378522524a0237c64323ecf3b3a599 Mon Sep 17 00:00:00 2001 From: Manuel Schmid Date: Thu, 28 Dec 2023 13:59:05 +0100 Subject: [PATCH] refactor and improve bug report and feature request issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 18 ----- .github/ISSUE_TEMPLATE/bug_report.yaml | 77 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ---- .github/ISSUE_TEMPLATE/feature_request.yaml | 34 +++++++++ 4 files changed, 111 insertions(+), 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 331426a3..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Bug report -about: Describe a problem -title: '' -labels: '' -assignees: '' - ---- - -**Read Troubleshoot** - -[x] I admit that I have read the [Troubleshoot](https://github.com/lllyasviel/Fooocus/blob/main/troubleshoot.md) before making this issue. - -**Describe the problem** -A clear and concise description of what the bug is. - -**Full Console Log** -Paste **full** console log here. You will make our job easier if you give a **full** log. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..bf89b78c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,77 @@ +name: Bug Report +description: Describe a problem +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report form! + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please make sure to troubleshoot yourself before continuing. + options: + - label: I have read the [Troubleshooting Guide](https://github.com/lllyasviel/Fooocus/blob/main/troubleshoot.md) + required: true + - label: I have checked that this is not a duplicate of an already existing [issue](https://github.com/lllyasviel/Fooocus/issues) + required: true + - type: textarea + id: description + attributes: + label: Describe the problem + description: Also tell us, what did you expect to happen? + placeholder: "A clear and concise description of what the bug is." + validations: + required: true + - type: textarea + id: logs + attributes: + label: Full console log output + description: Please copy and paste the **full** console log here. You will make our job easier if you give a **full** log. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + - type: textarea + id: version + attributes: + label: Version + description: What version of Fooocus are you using? (see browser tab title or console log) + placeholder: "Example: Fooocus 2.1.855" + validations: + required: true + - type: dropdown + id: hosting + attributes: + label: Where are you running Fooocus? + multiple: false + options: + - Locally + - Locally with virtualisation (e.g. Docker) + - Cloud (Gradio) + - Cloud (other) + validations: + required: true + - type: input + id: operating-system + attributes: + label: Operating System + description: What operating system are you using? + placeholder: "Example: macOS Big Sur" + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Chrome + - Firefox + - Microsoft Edge + - Safari + - other + validations: + required: true + - type: markdown + attributes: + value: "Thank you for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8101bc36..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -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 idea you'd like** -A clear and concise description of what you want to happen. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..e6a844cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,34 @@ +name: Feature request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request form! + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have checked that this is not a duplicate of an already existing [feature request](https://github.com/lllyasviel/Fooocus/issues) + required: true + - type: textarea + id: relation-to-problem + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +." + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the idea you'd like + placeholder: "A clear and concise description of what you want to happen." + validations: + required: true + - type: markdown + attributes: + value: "Thank you for completing our form!"