From ca9bf02250f6ff8d15bc9566a45417a18a4d4ea7 Mon Sep 17 00:00:00 2001 From: Catfriend1 <16361913+Catfriend1@users.noreply.github.com> Date: Thu, 22 May 2025 23:16:00 +0200 Subject: [PATCH] Issue template update (#1445) --- .github/ISSUE_TEMPLATE/bug_report.yml | 100 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + CONTRIBUTING.md | 7 +- ISSUE_TEMPLATE.md | 27 ------- scripts/debug/adb_get_log.cmd | 17 +++++ scripts/debug/adb_push_config_xml.cmd | 30 -------- 6 files changed, 123 insertions(+), 59 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 ISSUE_TEMPLATE.md create mode 100644 scripts/debug/adb_get_log.cmd delete mode 100644 scripts/debug/adb_push_config_xml.cmd diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..02fb72f37 --- /dev/null +++ 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b22b38a30..367a3bc3c 100644 --- 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 diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 7cdc8411b..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ - - -### 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 -- Device manufacturer: -- Device model: - -### Device platform info - -```sh - -``` - - -### Android Log - -```sh - -``` diff --git a/scripts/debug/adb_get_log.cmd b/scripts/debug/adb_get_log.cmd new file mode 100644 index 000000000..5134940c3 --- /dev/null +++ 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 diff --git a/scripts/debug/adb_push_config_xml.cmd b/scripts/debug/adb_push_config_xml.cmd deleted file mode 100644 index 776791fbd..000000000 --- a/scripts/debug/adb_push_config_xml.cmd +++ /dev/null @@ -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