Update Issue Templates, provide new PR template, move all to .gitea

This commit is contained in:
vanous
2022-08-07 20:45:49 +02:00
parent c2054c4a8b
commit 6a5facde3d
5 changed files with 33 additions and 11 deletions
+49
View File
@@ -0,0 +1,49 @@
---
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.
+49
View File
@@ -0,0 +1,49 @@
---
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.
+52
View File
@@ -0,0 +1,52 @@
---
name: Device request
about: Request for a new device
labels:
- device request
---
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
- Adding an implementation for a new device requires 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.
- 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, because without a physical device, we cannot really implement it at all:
- 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.
+40
View File
@@ -0,0 +1,40 @@
---
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.
+14
View File
@@ -0,0 +1,14 @@
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!
---