mirror/Meshtastic-Android
1
0
Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-05-06 21:56:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(issues): overhaul issue templates (#3012)

Browse Source 
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
Co-authored-by: DaneEvans <dane@goneepic.com>
This commit is contained in:
James Rich
2025-09-07 10:39:27 -05:00
committed by GitHub
parent 8e66360b60
commit e72a83c626
2 changed files with 188 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

221
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View File

@@ -2,13 +2,15 @@ name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: [bug]
type: Bug
projects: [meshtastic/Meshtastic-Android]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Thank you for helping to make Meshtastic-Android better by reporting a bug. :hugs:
Please provide as much detail as possible so we can efficiently address your issue and avoid unnecessary back-and-forth.
- type: input
id: contact
attributes:
@@ -17,88 +19,159 @@ body:
placeholder: ex. email@example.com, discord username
validations:
required: false
- type: textarea
id: what-happened
- type: checkboxes
id: checklist
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: A bug happened!
validations:
required: true
- type: textarea
id: app_version
label: "Checklist"
description: |
Please make sure you have done the following before submitting your bug report.
Bug reports that do not meet these criteria will be closed.
Requests that do not meet these criteria will be closed.
Links:
[**OPEN ISSUES**](https://github.com/meshtastic/Meshtastic-Android/issues)
[**CLOSED ISSUES**](https://github.com/meshtastic/Meshtastic-Android/issues?q=is%3Aissue+is%3Aclosed)
[Contribution Guidelines](https://github.com/meshtastic/Meshtastic-Android/blob/main/README.md#contributing)
options:
- label: |
I am able to reproduce the bug with the latest version.
required: true
- label: |
I made sure that there are no existing **OPEN or CLOSED issues** which I could contribute my information to.
required: true
- label: |
I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise.
required: true
- label: |
This issue contains only one bug.
required: true
- label: |
I have read and understood the **Contribution Guidelines**.
required: true
- label: |
I agree to follow this project's Code of Conduct
required: true
- type: input
id: app-version
attributes:
label: App Version
description: What version of Meshtastic Android are you running?
placeholder: 2.4.1
validations:
required: true
- type: textarea
id: phone
attributes:
label: Phone
description: What phone/tablet and OS are you running it on?
placeholder: Pixel 8a, Android 15
validations:
required: true
- type: textarea
id: radio
attributes:
label: Device
description: Which meshtastic radio device are you connecting to?
placeholder: heltec v3
validations:
required: true
- type: textarea
id: firmware
attributes:
label: Firmware
description: Which meshtastic firmware is running on the device?
placeholder: 2.4.1.394e0e1 Beta
label: Affected app version
description: |
In which Meshtastic-Android app version did you encounter the bug?
Can be seen on the bottom of the `Settings` screen in the app.
placeholder: "x.y.z-channel.x (build) flavor"
validations:
required: true
- type: markdown
- type: input
id: phone-os
attributes:
value: |
Logs help us to diagnose and reproduce issues, particularly when they are unique to your setup.
Depending on the issue, the following logs may be useful:
- App logs: This will help with most issues.
- Use logcat (with Android studio is simplest) and filter by com.geeksville.mesh
- Mesh logs: UI issues, communication issues etc.
- ` App > Menu > Debug Panel > Export specific / export all `
- Android logs: Potentially useful if the issue goes beyond the app (connections, network etc.)
- Use logcat (with Android studio is simplest) and figure out what filters are needed to show us what is going wrong.
- Firmware logs: Useful for all connection issues with nodes
- These are piped to the USB serial port on the node, the most foolproof is to use the 'open serial' button on the web-flasher interface, and then save the output.
- You need to be connecting to the node via Bluetooth or Network for this to work.
- type: markdown
label: Affected Android version
description: |
With what operating system (+ version) did you encounter the bug?
placeholder: "Example: Android 14"
validations:
required: true
- type: input
id: phone-model
attributes:
value: |
### Relevant log output
<!--
uncomment this section to fold logs
<details>
<summary>Expand Logs ... </summary>
-->
label: Affected phone model
description: |
On what phone did you encounter the bug?
placeholder: "Example: Samsung Galaxy S20 / Google Pixel 8"
validations:
required: true
- type: input
id: hardware-model
attributes:
label: Affected node model
placeholder: "Example: Seeed T1000-E, Heltec v3, etc."
description: |
On which hardware device (Node) did you encounter the bug?
validations:
required: true
- type: input
id: firmware-version
attributes:
label: Affected node firmware version
placeholder: "x.x.x"
description: "Which Meshtastic firmware version did you encounter the bug?"
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce the bug
description: |
What did you do for the bug to show up?
If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
placeholder: |
1. Go to '...'
2. Press on '....'
3. Swipe down to '....'
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: |
Tell us what happens with the steps given above.
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
Tell us what you expect to happen.
- type: textarea
id: screen-media
attributes:
label: Screenshots/Screen recordings
description: |
A picture or video is worth a thousand words.
Provide as much context as possible so we know what we are looking at.
Add screenshots or a screen recording to help explain your problem, provide detailed context to help us know what to look for.
GitHub supports uploads of images and (small) videos directly in the text box.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
description: |
Logs help us to diagnose and reproduce issues, particularly when they are unique to your setup.
Depending on the issue, the following logs may be useful:
- App logs: This will help with most issues. If possible, provide the relevant output of:
`adb logcat -d | grep com.geeksville.mesh`
- Mesh logs: UI issues, communication issues etc.
- ` App > Settings > Advanced > Debug Panel > Export specific / export all `
- Broader Android logs: Potentially useful if the issue goes beyond the app (connections, network etc.)
`adb logcat -d`
- Firmware logs: Useful for all connection issues with nodes
- These are piped to the USB serial port on the node, the most foolproof is to use the 'open serial' button on the web-flasher interface, and then save the output.
- The app needs to be connecting to the node via Bluetooth or Network for this to work.
render: shell
- type: markdown
- type: textarea
id: additional-information
attributes:
value: |
<!--
</details>
-->
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://meshtastic.org/docs/legal/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
label: Additional information
description: |
Any other information you'd like to include, for instance that
* the affected device is foldable or a TV
* you have disabled all animations on your device or otherwise changed system settings
* you are using battery optimization or power saving mode
* you are using a custom Android ROM or launcher
* your ferret chewed your antennas
* you are using a VPN
* you live in a faraday cage
* you dismissed all popups telling you not to do things you shouldn't do without reading them
* ...

63
.github/ISSUE_TEMPLATE/feature_request.yml vendored
View File

@@ -2,13 +2,38 @@ name: Feature Request
description: File a request for new feature or functionality.
title: "[Feature Request]: "
labels: [enhancement]
type: Feature
projects: [meshtastic/Meshtastic-Android]
body:
- type: markdown
- type: checkboxes
id: checklist
attributes:
value: |
Thanks for taking the time to fill out this feature request!
label: Checklist
description: |
Please make sure you have done the following before submitting your feature request.
Requests that do not meet these criteria will be closed.
Links:
[**OPEN ISSUES**](https://github.com/meshtastic/Meshtastic-Android/issues)
[**CLOSED ISSUES**](https://github.com/meshtastic/Meshtastic-Android/issues?q=is%3Aissue+is%3Aclosed)
[Contribution Guidelines](https://github.com/meshtastic/Meshtastic-Android/blob/main/README.md#contributing)
options:
- label:
I have used the search function for **OPEN ISSUES** to see if someone else has already submitted the same feature request.
required: true
- label: |
I have **also** used the search function for **CLOSED ISSUES** to see if the feature was already implemented and is just waiting to be released, or if the feature was rejected.
required: true
- label: |
I will describe the request with as much detail as possible.
required: true
- label: |
This request contains only one single feature, **not** a list of multiple (related) features.
required: true
- label: |
I have read and understood the **Contribution Guidelines**.
required: true
- label: |
I agree to follow this project's Code of Conduct
required: true
- type: input
id: contact
attributes:
@@ -18,25 +43,19 @@ body:
validations:
required: false
- type: textarea
id: request
id: feature
attributes:
label: Tell us your idea.
description: Tell us what you'd like the app to do. Give as much detail as you can.
placeholder: Your idea
value: I'd like the app to...
validations:
required: true
label: Feature or improvement you want
description: Try to be as specific as possible. Please not only explain what the feature does, but also how.
- type: textarea
id: logs
id: reason
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
label: Why should this be added?
description: |
What problem does the feature solve? In what use-cases is the feature needed?
Is this supported by the firmware? Please provide links to relevant firmware issues or PRs if applicable.
- type: textarea
id: screenshots
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://meshtastic.org/docs/legal/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
label: Screenshots / Drawings / Technical details
description: If your request is about (or includes) changing or extending the UI, describe what the UI would look like and how the user would interact with it.