Issue template update (#1445)

2025-05-22 23:16:00 +02:00 · 2025-05-22 23:16:00 +02:00 · ca9bf02250
commit ca9bf02250
parent 0e9f68b9ae
6 changed files with 123 additions and 59 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@ -0,0 +1,100 @@
+name: Bug Report
+description: Report a bug with as much detail as possible to help us reproduce it.
+title: "[Bug] "
+labels: []
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue! Please fill out the following fields as completely as possible.
+
+  - type: input
+    id: issue_description
+    attributes:
+      label: Description of the issue
+      description: A clear and concise description of what the bug is and what you expected to happen.
+      placeholder: What happened? What did you expect?
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction_steps
+    attributes:
+      label: Steps to reproduce
+      description: Step-by-step instructions to reproduce the issue.
+      placeholder: |
+        1. Open the app
+        2. Click on the first folder
+        3. Edit option A
+        4. ...
+        5. I expected that the option is saved. I experienced the app crashed instead.
+    validations:
+      required: true
+
+  - type: input
+    id: app_version
+    attributes:
+      label: App version
+      placeholder: e.g. v1.2.3.4
+    validations:
+      required: true
+
+  - type: dropdown
+    id: install_source
+    attributes:
+      label: App install source - see wiki for details on release channels
+      options:
+        - F-Droid release build
+        - GitHub trusted debug build
+        - GitHub untrusted debug build
+        - GitHub release build
+        - Google Play Store release build
+    validations:
+      required: true
+
+  - type: input
+    id: android_version
+    attributes:
+      label: Android version
+      placeholder: e.g. Android 11
+    validations:
+      required: true
+
+  - type: input
+    id: rom_vendor
+    attributes:
+      label: ROM vendor
+      placeholder: e.g. LineageOS, Stock, Xiaomi.EU
+    validations:
+      required: true
+
+  - type: input
+    id: device_manufacturer
+    attributes:
+      label: Device manufacturer
+      placeholder: e.g. Samsung, Xiaomi, Huawei
+    validations:
+      required: false
+
+  - type: input
+    id: device_model
+    attributes:
+      label: Device model
+      placeholder: e.g. SM-G960F, H815
+    validations:
+      required: false
+
+  - type: textarea
+    id: device_platform_info
+    attributes:
+      label: Device platform info (optional)
+      description: Output of `adb shell "getprop | grep ro.product"`.
+      render: shell
+
+  - type: textarea
+    id: android_log
+    attributes:
+      label: Android log (logcat)
+      description: On Windows, run [adb_get_log.cmd](https://github.com/Catfriend1/syncthing-android/blob/main/scripts/debug/adb_get_log.cmd). On Linux, run `adb logcat *:V`.
+      render: shell
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1 @@
+blank_issues_enabled: false
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -22,8 +22,11 @@ You can get logs in various ways:

 - Log window in the app: Settings -> Open Log -> Android Log

- - Install [adb](http://www.howtogeek.com/125769/how-to-install-and-use-abd-the-android-debug-bridge-utility/), 
-   and run `adb logcat`. To see only info about crashes, run `adb logcat -s *:E`.
+ - Install [adb](http://www.howtogeek.com/125769/how-to-install-and-use-abd-the-android-debug-bridge-utility/)
+ 
+ - On Windows: Run [adb_get_log.cmd](https://github.com/Catfriend1/syncthing-android/blob/main/scripts/debug/adb_get_log.cmd) to grab the log while you reproduce the problem. Please mention the timestamp when the problem occured.
+ 
+ - On Linux: Run `adb logcat *:V`. To see only info about crashes, run `adb logcat -s *:E`.

 - Using one of the various "logcat apps" on Google Play and F-Droid

--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@ -1,27 +0,0 @@
-<!-- If you have issues with this fork, feel free to post them. I'll look into them if a good reproducer or log is provided. -->
-
-### Description of the issue
-
-### Reproduction Steps
-
-### Version Information
- App Version: 1.x.y.z
- App installed from: GitHub (signed apk), F-Droid, G-Play
- Android Version: Android x.y <!-- / LineAgeOS x.y / ... -->
- Device manufacturer: <!--  Huawei / LG / Samsung / Xiaomi / ... -->
- Device model: <!-- I9100 / H815 / MI8 / ... -->
-
-### Device platform info
-<!-- adb shell "getprop | grep ro.product" -->
-```sh
-
-```
-
-
-### Android Log
-<!-- output of 
-    adb logcat v
-    or MatLog (search on GitHub) -->
-```sh
-
-```
--- a/scripts/debug/adb_get_log.cmd
+++ b/scripts/debug/adb_get_log.cmd
@ -0,0 +1,17 @@
+@echo off
+setlocal enabledelayedexpansion
+::
+SET "PACKAGE_ID_DEBUG=com.github.catfriend1.syncthingandroid.debug"
+SET "PACKAGE_ID_RELEASE=com.github.catfriend1.syncthingandroid"
+::
+where adb >NUL: 2>&1 || (echo [ERROR] adb is missing. Please install it first. Stop. & goto :eof)
+::
+FOR /F "delims=" %%I IN ('adb shell pidof %PACKAGE_ID_RELEASE%') DO SET PID=%%I
+IF NOT DEFINED PID FOR /F "delims=" %%I IN ('adb shell pidof %PACKAGE_ID_DEBUG%') DO SET PID=%%I
+IF NOT DEFINED PID echo [ERROR] Syncthing-Fork is NOT installed. Please install it first. Stop. & goto :eof
+::
+echo [INFO] Found PID: %PID%
+timeout /nobreak 1 >NUL:
+adb logcat --pid=%PID% *:V
+::
+goto :eof
--- a/scripts/debug/adb_push_config_xml.cmd
+++ b/scripts/debug/adb_push_config_xml.cmd
@ -1,30 +0,0 @@
-@echo off
-cls
-SET SCRIPT_PATH=%~dps0
-cd /d "%SCRIPT_PATH%"
-REM 
-REM Script Consts.
-REM 
-REM 	SET PACKAGE_NAME=com.github.catfriend1.syncthingandroid
-SET PACKAGE_NAME=com.github.catfriend1.syncthingandroid.debug
-REM 
-REM 	SET DATA_ROOT=/data/user/0
-SET DATA_ROOT=/data/data
-REM 
-SET USE_ROOT=0
-SET PACKAGE_UID=u0_a96
-REM 
-:loopMe
-cls
-adb root
-IF "%USE_ROOT%" == "1" adb shell ls -a -l "%DATA_ROOT%/%PACKAGE_NAME%/files/config.xml"
-adb push "%SCRIPT_PATH%config-frozen.xml" "%DATA_ROOT%/%PACKAGE_NAME%/files/config.xml"
-IF "%USE_ROOT%" == "1" adb shell chmod 0600 "%DATA_ROOT%/%PACKAGE_NAME%/files/config.xml"
-IF "%USE_ROOT%" == "1" adb shell chown %PACKAGE_UID%:%PACKAGE_UID% "%DATA_ROOT%/%PACKAGE_NAME%/files/config.xml"
-IF "%USE_ROOT%" == "1" adb shell ls -a -l "%DATA_ROOT%/%PACKAGE_NAME%/files/config.xml"
-echo.
-pause
-echo.
-echo ==========================================================
-echo.
-goto :loopMe