From f3c7df7195bf47e7d62af12bb9a6711a92611e81 Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Wed, 11 Jun 2025 20:39:34 +0200 Subject: [PATCH] chore: switch to YAML issue templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 43 ----------- .github/ISSUE_TEMPLATE/Feature_request.md | 14 ---- .github/ISSUE_TEMPLATE/bug_report.yaml | 86 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 30 +++++++ 4 files changed, 116 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml 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 148f064..0000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Thanks for helping us out! - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -(Please paste any information on reproducing the issue, for example:) - -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. If you believe you -have aptly described your issue in words, feel free to ignore/delete this section. - -**Please fill out the following information;** - -- Node version: [This can be obtained by running `node -v` in your terminal] -- Have you updated to the latest MagicMirror core? (yes/no) -- Please post the relevant part of your config file here: - -```json -(Paste the part of the config file here) -``` - -- Please post any errors you see about MMM-pages in the console (Hit F12 > Console when the MagicMirror window is focused), or write **None** if there aren't any: - -```bash -(Paste the error here) -``` - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index c200afc..0000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Why do you want this feature?** - - -**Describe the solution you'd like** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..7c1614b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,86 @@ +name: Bug report +description: Create a report to help us improve MMM-pages. +title: "Bug: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + + - type: input + id: node-version + attributes: + label: Node Version + description: Run `node -v` in your terminal + placeholder: "e.g., v22.14.0" + validations: + required: true + + - type: checkboxes + id: core-updated + attributes: + label: MagicMirror Core Update Status + description: Have you updated to the latest MagicMirror core? + options: + - label: Yes, I am using the latest version + required: true + + - type: textarea + id: config + attributes: + label: Configuration + description: Please paste the relevant part of your config file + render: json + validations: + required: true + + - type: textarea + id: console-errors + attributes: + label: Console Errors + description: Please paste any errors you see about MMM-pages in the console (Hit F12 > Console when the MagicMirror window is focused) + render: shell + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..70fa4f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,30 @@ +name: Feature request +description: Suggest an idea for this project. +title: "Feature: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: "Thanks for taking the time to fill out this feature request!" + - type: textarea + id: problem + attributes: + label: Problem Description + description: Is your feature request related to a problem? Why do you want this feature? + placeholder: "I'm always frustrated when [...] or It'd be cool if [...]" + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: What would you like to see? A config option? A notification? Something else? + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. + validations: + required: false