From adeb9bccb179b2394760ee0f6bd495cc64975704 Mon Sep 17 00:00:00 2001 From: Shaun Eccles-Smith Date: Thu, 4 Nov 2021 22:23:53 +1100 Subject: [PATCH] Use New Issue Forms for Bug Reports (#2312) * Convert to Github Issue Forms * Remove pre-filled title * Change bug report from textarea to input --- .github/ISSUE_TEMPLATE/bug.md | 27 ----------- .github/ISSUE_TEMPLATE/bug.yml | 83 ++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 27 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index c3536b2c..00000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Bug -about: Noticed an issue with your lights? -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. Please quickly search existing issues first! - -**To Reproduce** -Steps to reproduce the behavior, if consistently possible - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**WLED version** - - Board: [e.g. Wemos D1, ESP32 dev] - - Version [e.g. 0.10.0, dev200603] - - Format [e.g. Binary, self-compiled] - -**Additional context** -Anything else you'd like to say about the problem? - -Thank you for your help! diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..30e5f3bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,83 @@ +name: Bug Report +description: File a bug report +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please quickly search existing issues first before submitting a bug. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear and concise description of what the bug is. + placeholder: Tell us what the problem is. + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: To Reproduce Bug + description: Steps to reproduce the behavior, if consistently possible. + placeholder: Tell us how to make the bug appear. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + placeholder: Tell us what you expected to happen. + validations: + required: true + - type: dropdown + id: install_format + attributes: + label: Install Method + description: How did you install WLED? + options: + - Binary from WLED.me + - Self-Compiled + validations: + required: true + - type: input + id: version + attributes: + label: What version of WLED? + description: You can find this in by going to Config -> Security & Updates -> Scroll to Bottom. Copy and paste the entire line after "Server message" + placeholder: "e.g. WLED 0.13.0-b4 (build 2110110)" + validations: + required: true + - type: dropdown + id: Board + attributes: + label: Which microcontroller/board are you seeing the problem on? + multiple: true + options: + - ESP8266 + - ESP32 + - Other + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log/trace output + description: Please copy and paste any relevant log output if you have it. This will be automatically formatted into code, so no need for backticks. + render: shell + - 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 + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Aircoookie/WLED/blob/master/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file