Browse Source

fix: improved github feature request and bug templates

pull/461/head
Dan Ditomaso 1 year ago
parent
commit
16d04bb878
  1. 82
      .github/ISSUE_TEMPLATE/bug.yml
  2. 58
      .github/ISSUE_TEMPLATE/feature.yml

82
.github/ISSUE_TEMPLATE/bug.yml

@ -6,8 +6,20 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | 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 - type: dropdown
id: hardware id: hardware
attributes: attributes:
@ -41,7 +53,6 @@ body:
- Other - Other
validations: validations:
required: true required: true
- type: dropdown - type: dropdown
id: category id: category
attributes: attributes:
@ -54,7 +65,6 @@ body:
- Serial - Serial
validations: validations:
required: true required: true
- type: dropdown - type: dropdown
id: local id: local
attributes: attributes:
@ -66,7 +76,6 @@ body:
- https://client.meshtastic.org - https://client.meshtastic.org
validations: validations:
required: true required: true
- type: input - type: input
id: version id: version
attributes: attributes:
@ -75,15 +84,50 @@ body:
placeholder: x.x.x.yyyyyyy placeholder: x.x.x.yyyyyyy
validations: validations:
required: true required: true
- type: input
id: os
attributes:
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 - type: textarea
id: body id: expected
attributes: attributes:
label: Description label: Expected Behavior
description: Please provide details on what steps you performed for this to happen. 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: validations:
required: true required: true
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
@ -92,3 +136,21 @@ body:
render: Shell render: Shell
validations: validations:
required: false 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!

58
.github/ISSUE_TEMPLATE/feature.yml

@ -6,12 +6,60 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for your request this will not gurantee that we will implement it, but it will be reviewed. Thanks for your request. While we can't guarantee implementation, all requests will be carefully reviewed.
- type: checkboxes
id: prerequisites
attributes:
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 - type: textarea
id: body id: solution
attributes: attributes:
label: Description label: Proposed Solution
description: Please provide details about your enhancement. description: Describe your idea for solving the problem. What would you like to see implemented?
placeholder: It would be great if...
validations: validations:
required: true 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!
Loading…
Cancel
Save