mirror of
https://codeberg.org/Freeyourgadget/Gadgetbridge
synced 2024-11-27 04:16:49 +01:00
Add issue forms
This commit is contained in:
Yusuf Cihan
Yusuf Cihan
parent
d63db41f90
commit
6ca415a6b0
@ -1,49 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
|
||||
---
|
||||
You can use the `Preview` tab ^ above to see final rendering of your report. Use `x` in brackets ([x]) to "check" a checkbox.
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix: [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
|
||||
|
||||
#### Before reporting a bug, please confirm the following:
|
||||
- [ ] I have read the [wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] If you upload an image or other content, please make sure you have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md)
|
||||
|
||||
### Where did you get Gadgetbridge from:
|
||||
* [ ] F-Droid
|
||||
* [ ] Gadgetbridge Nightly F-Droid repository
|
||||
* [ ] Bangle.js Gadgetbridge from the Play Store
|
||||
* [ ] I built it myself from source code (specify tag / commit)
|
||||
* [ ] I previously used Gadgetbridge from other sources and then updated to F-Droid version
|
||||
|
||||
### Your Gadgetbridge version is:
|
||||
|
||||
(This can be found in Gadgetbridge - Menu - About: Version and Commit)
|
||||
|
||||
#### Your issue is:
|
||||
*If possible, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)! that might help identifying the problem.*
|
||||
*Long logs can be also included but make sure to tuck them into the `details` tag:*
|
||||
|
||||
<details>
|
||||
<summary>Click to see my log under this fold</summary>
|
||||
|
||||
```
|
||||
Here go lines of your log.
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
#### Your wearable device is:
|
||||
|
||||
*Please specify model and firmware version if possible*
|
||||
|
||||
#### Your Android version/manufacturer flavor is:
|
||||
|
||||
|
||||
*New issues about already solved/documented topics could be closed without further comments. Same for too generic or incomplete reports.*
|
||||
|
||||
Please use `Preview` tab above to see final rendering of your report before submitting.
|
||||
@ -1,49 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
|
||||
---
|
||||
You can use the `Preview` tab ^ above to see final rendering of your report. Use `x` in brackets ([x]) to "check" a checkbox.
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix: [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
|
||||
|
||||
#### Before reporting a bug, please confirm the following:
|
||||
- [ ] I have read the [wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] If you upload an image or other content, please make sure you have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md)
|
||||
|
||||
### Where did you get Gadgetbridge from:
|
||||
* [ ] F-Droid
|
||||
* [ ] Gadgetbridge Nightly F-Droid repository
|
||||
* [ ] Bangle.js Gadgetbridge from the Play Store
|
||||
* [ ] I built it myself from source code (specify tag / commit)
|
||||
* [ ] I previously used Gadgetbridge from other sources and then updated to F-Droid version
|
||||
|
||||
### Your Gadgetbridge version is:
|
||||
|
||||
(This can be found in Gadgetbridge - Menu - About: Version and Commit)
|
||||
|
||||
#### Your issue is:
|
||||
*If possible, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)! that might help identifying the problem.*
|
||||
*Long logs can be also included but make sure to tuck them into the `details` tag:*
|
||||
|
||||
<details>
|
||||
<summary>Click to see my log under this fold</summary>
|
||||
|
||||
```
|
||||
Here go lines of your log.
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
#### Your wearable device is:
|
||||
|
||||
*Please specify model and firmware version if possible*
|
||||
|
||||
#### Your Android version/manufacturer flavor is:
|
||||
|
||||
|
||||
*New issues about already solved/documented topics could be closed without further comments. Same for too generic or incomplete reports.*
|
||||
|
||||
Please use `Preview` tab above to see final rendering of your report before submitting.
|
||||
@ -1,51 +0,0 @@
|
||||
---
|
||||
name: Device request
|
||||
about: Request for a new device
|
||||
labels:
|
||||
- device request
|
||||
---
|
||||
|
||||
You are trying to submit a request for a device implementation into Gadgetbridge. We cannot make any promise that the device will be implemented, as adding an implementation for a new device requires either an experienced or a willing to learn developer, ideally with the device at hand. Without that, you may try to submit a device request and see if anyone steps up and implements it and you are basically indicating that you have the device and are willing to help with testing, should anyone try to add this device to Gadgetbridge.
|
||||
|
||||
You can use the `Preview` tab ^ above to see final rendering of your report. Use `x` in brackets ([x]) to "check" a checkbox.
|
||||
|
||||
#### Before proceeding further, please confirm the following:
|
||||
- [ ] I have read the [wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki), and I didn't find this device mentioned there
|
||||
- [ ] I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find this device mentioned there
|
||||
- [ ] Please make sure you have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md)
|
||||
|
||||
#### Device information
|
||||
|
||||
- Provide device name, manufacturer and similarity to other devices:
|
||||
|
||||
|
||||
- Ideally, use an Android Bluetooth scanner app like nRF Connect or BLExplorer and provide screenshots of the scanned device from that app. This provides a name and some available UUIDs, which are needed for implementation. You may want to blur a MAC address for privacy reasons.
|
||||
|
||||
|
||||
- Specify model and firmware version if possible:
|
||||
|
||||
|
||||
- Please let us know if you have the device and if you are able to provide logs and testing:
|
||||
|
||||
|
||||
- If you want to help getting this device supported (and thus speed up the process), please take a look at:
|
||||
- what you can do as a user: [Support for a new Device](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Support-for-a-new-Device)
|
||||
- if you are a developer and could maybe even help getting the code ready: [New Device Tutorial](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/New-Device-Tutorial)
|
||||
|
||||
- If possible, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)! which might help to implement the device support into Gadgetbridge.
|
||||
*Long logs can be also included in the text but make sure to tuck them into the `details` tag below:*
|
||||
|
||||
<details>
|
||||
<summary>Click to see my log under this fold</summary>
|
||||
|
||||
```
|
||||
Here go lines of your log.
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
|
||||
*New issues about already solved/documented topics could be closed without further comments. Same for too generic or incomplete reports.*
|
||||
|
||||
Please use `Preview` tab above to see final rendering of your report before submitting.
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest a feature or an idea
|
||||
---
|
||||
You can use the `Preview` tab ^ above to see final rendering of your report. Use `x` in brackets ([x]) to "check" a checkbox.
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix: [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
|
||||
#### Before requesting a new feature, please confirm the following:
|
||||
- [ ] I have read the [wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find a solution to my problem / an answer to my question.
|
||||
- [ ] If you upload an image or other content, please make sure you have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md)
|
||||
|
||||
#### Log files
|
||||
*If applicable, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)*
|
||||
*Long logs can be also included in the text but make sure to tuck them into the `details` tag below:*
|
||||
|
||||
<details>
|
||||
<summary>Click to see my log under this fold</summary>
|
||||
|
||||
```
|
||||
Here go lines of your log.
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
#### Your wearable device is:
|
||||
|
||||
*Please specify model and firmware version if possible*
|
||||
|
||||
#### Your Android version/manufacturer flavor is:
|
||||
|
||||
#### Your Gadgetbridge version is:
|
||||
|
||||
|
||||
|
||||
*New requests about already solved/documented topics could be closed without further comments. Same for too generic or incomplete reports.*
|
||||
|
||||
Please use `Preview` tab above to see final rendering of your report before submitting.
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
Thank you for your contribution! 🎉
|
||||
|
||||
Please make sure that you:
|
||||
|
||||
- Use `git rebase` to bring your branch up to date, do not use a merge commit
|
||||
for that
|
||||
- Do not add translations by editing the language variants of strings.xml as
|
||||
that creates merge conflicts between Codeberg git repo and Weblate git repo,
|
||||
use Weblate https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge/
|
||||
- do not use `e.printStacktrace()`, use slf4j logger or `GB.toast` for logging
|
||||
as per https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Developer-Documentation#logging
|
||||
- Please erase these hints from this PR :), thank you!
|
||||
---
|
||||
|
||||
79
.gitea/issue_template/bug_report.yml
Normal file
79
.gitea/issue_template/bug_report.yml
Normal file
@ -0,0 +1,79 @@
|
||||
name: Bug report
|
||||
about: Create a report to help us improve.
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to make Gadgetbridge better!
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix at [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Please confirm that;
|
||||
options:
|
||||
- label: I have checked the [website](https://gadgetbridge.org), and I didn't find a solution to my problem / an answer to my question.
|
||||
required: true
|
||||
- label: I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find a solution to my problem / an answer to my question.
|
||||
required: true
|
||||
- label: I have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md) for images or other type of content that I included here.
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: source
|
||||
attributes:
|
||||
label: Where did you get Gadgetbridge from?
|
||||
options:
|
||||
- F-Droid
|
||||
- Gadgetbridge Nightly F-Droid repository
|
||||
- Bangle.js Gadgetbridge from the Play Store
|
||||
- I built it myself from source code
|
||||
- I previously used Gadgetbridge from other sources and then updated to F-Droid version
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: What is your Gadgetbridge version?
|
||||
description: |
|
||||
This can be found in "Menu > About > Version" in Gadgetbridge.
|
||||
Also include tag / commit SHA if you built Gadgetbridge from the source.
|
||||
placeholder: e.g. "0.77.0" or "0.77.0-2618adac1" to include commit
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: content
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: >
|
||||
Please note that new issues about already solved/documented topics
|
||||
**could be closed without further comments.** Same for too generic or incomplete reports.
|
||||
placeholder: If you want to include logs, don't include it here. Use the next text field for that.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Do you have logs?
|
||||
description: >
|
||||
If possible, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)
|
||||
that might help identifying the problem. This will be automatically formatted into
|
||||
code, so no need for backticks.
|
||||
render: shell
|
||||
- type: input
|
||||
id: gadget
|
||||
attributes:
|
||||
label: What gadget do you use?
|
||||
description: >
|
||||
Please specify model and firmware version if possible. Leave blank if you believe the
|
||||
issue is not specific to the gadget that you currently use with Gadgetbridge.
|
||||
placeholder: e.g. ExampleWatch A1 with 0.1 firmware
|
||||
- type: input
|
||||
id: android
|
||||
attributes:
|
||||
label: What is your Android version/manufacturer flavor?
|
||||
description: >
|
||||
Android phone manufacturers may customise the Android source code as they wish, so
|
||||
if you are using a phone that running a vendor-exclusive system (like MIUI) or if
|
||||
you use a custom ROM, make sure to also include the name of the OS/ROM.
|
||||
placeholder: e.g. LineageOS 20 based on Android 13
|
||||
validations:
|
||||
required: true
|
||||
11
.gitea/issue_template/config.yml
Normal file
11
.gitea/issue_template/config.yml
Normal file
@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Ask a question
|
||||
url: https://matrix.to/#/#gadgetbridge:matrix.org
|
||||
about: If you just have a question, please ask in the user chatroom in Matrix.
|
||||
- name: Website
|
||||
url: https://gadgetbridge.org
|
||||
about: Visit Gadgetbridge website for FAQ, getting started and common troubleshooting.
|
||||
- name: See supported gadgets
|
||||
url: https://gadgetbridge.org/gadgets/
|
||||
about: List of all supported gadget vendors and models in Gadgetbridge.
|
||||
77
.gitea/issue_template/device_request.yml
Normal file
77
.gitea/issue_template/device_request.yml
Normal file
@ -0,0 +1,77 @@
|
||||
name: Device request
|
||||
about: Request for a new device/gadget.
|
||||
labels:
|
||||
- device request
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
You are trying to submit a request for a device implementation into Gadgetbridge.
|
||||
**We cannot make any promise that the device will be implemented**, as adding an implementation
|
||||
for a new device requires either an experienced or a willing to learn developer,
|
||||
ideally with the device at hand. Without that, you may try to submit a device request
|
||||
and see if anyone steps up and implements it and you are basically indicating that you
|
||||
have the device and are willing to help with testing, should anyone try to add
|
||||
this device to Gadgetbridge.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to make Gadgetbridge better!
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix at [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Please confirm that;
|
||||
options:
|
||||
- label: I have checked the [website](https://gadgetbridge.org) and [gadget list](https://gadgetbridge.org/gadgets/), and I didn't find this device mentioned there.
|
||||
required: true
|
||||
- label: I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find this device mentioned there.
|
||||
required: true
|
||||
- label: I have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md) for images or other type of content that I included here.
|
||||
required: true
|
||||
- type: input
|
||||
id: gadget
|
||||
attributes:
|
||||
label: Which gadget are you requesting support for?
|
||||
description: Please specify name, manufacturer, model and firmware version if possible.
|
||||
placeholder: e.g. ExampleWatch A1 with 0.1 firmware
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Does this gadget have similarities to other gadgets?
|
||||
description: >
|
||||
If the gadget you request support for has similarities to other gadgets that we currently support,
|
||||
it is more likely for us (still, not guaranteed) to add support for your gadget too.
|
||||
- type: textarea
|
||||
id: info
|
||||
attributes:
|
||||
label: Device information
|
||||
description: >
|
||||
Include all details about the gadget that will be useful to us when implementing a support for this gadget.
|
||||
|
||||
Ideally, use an Android Bluetooth scanner app like nRF Connect or BLExplorer and provide screenshots
|
||||
of the scanned gadget from that app. This provides a name and some available UUIDs, which are needed
|
||||
for implementation. You may want to blur MAC addresses for privacy reasons.
|
||||
placeholder: If you want to include logs, don't include it here. Use the next text field for that.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Do you have logs?
|
||||
description: >
|
||||
If possible, please attach [logs](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)
|
||||
which might help to implement the device support into Gadgetbridge. This will be automatically
|
||||
formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: dropdown
|
||||
id: source
|
||||
attributes:
|
||||
label: Do you have the gadget and are you able to help us for testing?
|
||||
options:
|
||||
- Yes, I have the gadget and I'm willing to provide further feedback and help testing.
|
||||
- No, I don't have the gadget or/and I'm not able to help during the development.
|
||||
validations:
|
||||
required: true
|
||||
78
.gitea/issue_template/feature_request.yml
Normal file
78
.gitea/issue_template/feature_request.yml
Normal file
@ -0,0 +1,78 @@
|
||||
name: Feature request
|
||||
about: Suggest a feature or an idea.
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to make Gadgetbridge better!
|
||||
|
||||
If you just have a question, please ask first in the user chatroom in Matrix at [`#gadgetbridge:matrix.org`](https://matrix.to/#/#gadgetbridge:matrix.org)
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Please confirm that;
|
||||
options:
|
||||
- label: I have checked the [website](https://gadgetbridge.org), and I didn't find a solution to my problem / an answer to my question.
|
||||
required: true
|
||||
- label: I have searched the [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues), and I didn't find a solution to my problem / an answer to my question.
|
||||
required: true
|
||||
- label: I have read and understood the [Codeberg Terms of Use](https://codeberg.org/Codeberg/org/src/branch/main/TermsOfUse.md) for images or other type of content that I included here.
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: source
|
||||
attributes:
|
||||
label: Where did you get Gadgetbridge from?
|
||||
options:
|
||||
- F-Droid
|
||||
- Gadgetbridge Nightly F-Droid repository
|
||||
- Bangle.js Gadgetbridge from the Play Store
|
||||
- I built it myself from source code
|
||||
- I previously used Gadgetbridge from other sources and then updated to F-Droid version
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: What is your Gadgetbridge version?
|
||||
description: |
|
||||
This can be found in "Menu > About > Version" in Gadgetbridge.
|
||||
Also include tag / commit SHA if you built Gadgetbridge from the source.
|
||||
placeholder: e.g. "0.77.0" or "0.77.0-2618adac1" to include commit
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: content
|
||||
attributes:
|
||||
label: What is your suggestion/idea?
|
||||
description: >
|
||||
Please note that new requests about already solved/documented topics
|
||||
**could be closed without further comments.** Same for too generic or incomplete reports.
|
||||
placeholder: If you want to include logs, don't include it here. Use the next text field for that.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Do you have logs?
|
||||
description: >
|
||||
If possible, please attach [logs.](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Log-Files)
|
||||
This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: input
|
||||
id: gadget
|
||||
attributes:
|
||||
label: What gadget do you use?
|
||||
description: >
|
||||
Please specify model and firmware version if possible. Leave blank if you believe the
|
||||
issue is not specific to the gadget that you currently use with Gadgetbridge.
|
||||
placeholder: e.g. ExampleWatch A1 with 0.1 firmware
|
||||
- type: input
|
||||
id: android
|
||||
attributes:
|
||||
label: What is your Android version/manufacturer flavor?
|
||||
description: >
|
||||
Android phone manufacturers may customise the Android source code as they wish, so
|
||||
if you are using a phone that running a vendor-exclusive system (like MIUI) or if
|
||||
you use a custom ROM, make sure to also include the name of the OS/ROM.
|
||||
placeholder: e.g. LineageOS 20 based on Android 13
|
||||
validations:
|
||||
required: true
|
||||
16
.gitea/pull_request_template.md
Normal file
16
.gitea/pull_request_template.md
Normal file
@ -0,0 +1,16 @@
|
||||
<!--
|
||||
Thank you for your contribution! 🎉
|
||||
|
||||
Please make sure that you:
|
||||
|
||||
- Use `git rebase` to bring your branch up to date, do not use a merge commit for that.
|
||||
|
||||
- Do not add translations by editing the language variants of strings.xml as that
|
||||
creates merge conflicts between Codeberg git repo and Weblate git repo,
|
||||
use Weblate https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge/
|
||||
|
||||
- Do not use `e.printStacktrace()`, use slf4j logger or `GB.toast` for logging
|
||||
as per https://gadgetbridge.org/internals/development/project-overview/#logging
|
||||
|
||||
You can erase this comment from PR description, thank you!
|
||||
-->
|
||||
Loading…
Reference in New Issue
Block a user