diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 26a99596e..cf4686c60 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,6 +3,9 @@ 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` ([web access via Element.io](https://app.element.io/#/room/#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. @@ -20,10 +23,10 @@ If you got it from Google Play, please note [that version](https://github.com/Ta *Long logs can be also included but make sure to tuck them into the `details` tag:*
- Click to see my log, which is a bit longer + Click to see my log under this fold ``` -Here go lines of that log. +Here go lines of your log. ```
@@ -39,3 +42,5 @@ Here go lines of that log. *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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9c853aa9f..cf4686c60 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,6 +3,9 @@ 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` ([web access via Element.io](https://app.element.io/#/room/#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. @@ -17,6 +20,16 @@ If you got it from Google Play, please note [that version](https://github.com/Ta #### 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:* + +
+ Click to see my log under this fold + +``` +Here go lines of your log. +``` +
+ #### Your wearable device is: @@ -29,3 +42,5 @@ If you got it from Google Play, please note [that version](https://github.com/Ta *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. diff --git a/.github/ISSUE_TEMPLATE/device_request.md b/.github/ISSUE_TEMPLATE/device_request.md new file mode 100644 index 000000000..a3b1e121a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/device_request.md @@ -0,0 +1,46 @@ +--- +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/master/TermsOfUse.md) + +#### Device information + +- Provide device name, manufacturer and similarity to other devices: + + +- 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:* + +
+ Click to see my log under this fold + +``` +Here go lines of your log. +``` +
+ + + + +*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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 1b008669c..f2190462b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,16 +1,28 @@ --- name: Feature request -about: Suggest an idea for this project - +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 or want to discuss some things, please do so in the user chatroom in Matrix: `#gadgetbridge:matrix.org` ([web access via Element.io](https://app.element.io/#/room/#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/master/TermsOfUse.md) -#### Your issue is: +#### 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:* + +
+ Click to see my log under this fold + +``` +Here go lines of your log. +``` +
+ #### Your wearable device is: @@ -23,3 +35,6 @@ about: Suggest an idea for this project *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. +