From 16d04bb8780fe7dec2ca98eebd762613cd331f90 Mon Sep 17 00:00:00 2001 From: Dan Ditomaso Date: Mon, 24 Feb 2025 10:05:58 -0500 Subject: [PATCH] fix: improved github feature request and bug templates --- .github/ISSUE_TEMPLATE/bug.yml | 84 ++++++++++++++++++++++++++---- .github/ISSUE_TEMPLATE/feature.yml | 60 ++++++++++++++++++--- 2 files changed, 127 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c8a4048b..75b6079d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -6,8 +6,20 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! - + # Bug Report + Thanks for taking the time to fill out this bug report! The more information you provide, the faster we can diagnose and fix the issue. + - type: checkboxes + id: prerequisites + attributes: + label: Before submitting + description: Please confirm you've completed the following steps + options: + - label: I have searched existing issues to make sure this bug hasn't already been reported + required: true + - label: I have updated to the latest version of the software to verify the issue still exists + required: true + - label: I have cleared cache/cookies/storage or tried in a private/incognito window (if applicable) + required: false - type: dropdown id: hardware attributes: @@ -41,7 +53,6 @@ body: - Other validations: required: true - - type: dropdown id: category attributes: @@ -54,7 +65,6 @@ body: - Serial validations: required: true - - type: dropdown id: local attributes: @@ -66,7 +76,6 @@ body: - https://client.meshtastic.org validations: required: true - - type: input id: version attributes: @@ -75,15 +84,50 @@ body: placeholder: x.x.x.yyyyyyy validations: required: true - - - type: textarea - id: body + - type: input + id: os attributes: - label: Description - description: Please provide details on what steps you performed for this to happen. + label: Operating System + description: What OS are you running? Include version if possible. + placeholder: e.g., Windows 11, macOS 13.1, Android 13, iOS 16.2 + validations: + required: true + - type: input + id: browser + attributes: + label: Browser + description: What browser are you using? Include version if possible. + placeholder: e.g., Chrome 108, Firefox 107, Safari 16.2 + validations: + required: false + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe what you expected to occur... + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + placeholder: Describe what occurred instead... + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide clear steps to reproduce the issue + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error validations: required: true - - type: textarea id: logs attributes: @@ -92,3 +136,21 @@ body: render: Shell validations: required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here. + validations: + required: false + - type: markdown + attributes: + value: | + Thank you for helping improve our project by reporting this bug! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index c92265e9..c4c8ba9d 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -6,12 +6,60 @@ body: - type: markdown attributes: value: | - Thanks for your request this will not gurantee that we will implement it, but it will be reviewed. - - - type: textarea - id: body + Thanks for your request. While we can't guarantee implementation, all requests will be carefully reviewed. + - type: checkboxes + id: prerequisites attributes: - label: Description - description: Please provide details about your enhancement. + label: Prerequisites + description: Please confirm the following before submitting your feature request + options: + - label: I have searched existing issues to ensure this feature hasn't already been requested + required: true + - label: I have checked the documentation to verify this feature doesn't already exist + required: true + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem are you trying to solve? Describe the challenge or limitation you're facing. + placeholder: I'm frustrated when... validations: required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe your idea for solving the problem. What would you like to see implemented? + placeholder: It would be great if... + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Current Alternatives + description: Are there any workarounds or alternative solutions you're currently using? + placeholder: Currently, I'm working around this by... + validations: + required: false + - type: dropdown + id: importance + attributes: + label: Importance + description: How important is this feature to you? + options: + - Nice to have + - Important + - Critical + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context, screenshots, mockups, or examples that might help us understand your request better. + validations: + required: false + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! \ No newline at end of file