AndroidJetpack/jerboa/.github/ISSUE_TEMPLATE/bug_report.yaml

name: 🐞 Bug report
description: Create a report to help us improve.
labels: ["bug", "triage"]
body:
  - type: input
    id: jerboaversion
    attributes:
      label: Jerboa Version
      description: Type the version from the settings here.
      placeholder: ex. 0.0.39
    validations:
      required: true
  - type: input
    id: androidversion
    attributes:
      label: Android Version + Phone
      description: Type the android version you are using and which phone here.
      placeholder: ex. Android 13, Google Pixel 7 Pro
    validations:
      required: true
  - type: textarea
    id: describebug
    attributes:
      label: Describe The Bug
      description: A clear and concise description of what the bug is.
      placeholder: ex. This should happen, but that happens instead.
    validations:
      required: true
  - type: textarea
    id: reproducebug
    attributes:
      label: To Reproduce
      description: Steps to reproduce the behavior.
      placeholder: |
        1. Go to '...'
        2. Click on '....'
        3. Scroll down to '....'
        4. See error
    validations:
      required: true
  - type: textarea
    id: incaseofcrash
    attributes:
      label: In the case of a crash or when relevant include the logs
      description: Please include the logs.
    validations:
      required: false
  - type: markdown
    attributes:
      value: |
        <hr />
        
        ### How do I get the full logs?
        **<details><summary>How to get the full logs (Click to expand)</summary>**
        > 
        > Follow these steps (skip the ones you already have done):
        > - Enable developer options and USB DEBUGGING
        > - Install ADB on your PC
        > - Connect your phone to your PC
        > - Execute this command on PC
        > ### To enable developer options and USB DEBUGGING
        > 
        > [Follow this article](https://developer.android.com/studio/debug/dev-options)
        > In essence you find the build number in About section of settings page and tap it a few times
        > Then open developer options and enable USB DEBUGGING
        > 
        > ### Install ADB on your PC
        > 
        > Download ADB from here [https://adbinstaller.com/](https://adbinstaller.com/)
        > 
        > Unzip it
        > 
        > [(Click here if you wanna know more about ADB)](https://developer.android.com/tools/adb)
        > 
        > ### Connect your phone to your PC
        > 
        > Use a USB cable to connect your phone to your PC
        > 
        > ### Execute this command on PC
        > On Windows open Powershell in the directory with the adb.exe (where you unzipped it, if you didn't add it to the PATH)
        > 
        > On Unix open a shell in the directory with the adb (where you unzipped it, if you didn't add it to the PATH)
        > 
        > To test if this is working type `adb devices`, this should output a device
        > 
        > Then execute this command 
        > ```shell
        > adb shell logcat *:V --pid $(adb shell "timeout 5s logcat | sed -En 's/.*proc ([0-9]*):com.jerboa.*/\1/p' | tail -1")
        > ```
        > The above command will print the full logs of the latest execution of Jerboa (regardless of which version/build).
        > 
        > Copy the full output. (If not possible just include the few lines below `FATAL EXCEPTION: main` )
        > 
        > Either include it as a file or paste it in the textarea above
        > 
        </details>
        
        ### How Do I Get Crash Logs?
        **<details><summary>FOR CRASHES ON STARTUP (Click to expand)</summary>**
        > 
        > Follow these steps (skip the ones you already have done):
        > - Enable developer options and USB DEBUGGING
        > - Install ADB on your PC
        > - Connect your phone to your PC
        > - Execute this command on PC
        > 
        > ### To enable developer options and USB DEBUGGING
        > 
        > [Follow this article](https://developer.android.com/studio/debug/dev-options)
        > In essence you find the build number in About section of settings page and tap it a few times
        > Then open developer options and enable USB DEBUGGING
        > 
        > ### Install ADB on your PC
        > 
        > Download ADB from here [https://adbinstaller.com/](https://adbinstaller.com/)
        > 
        > Unzip it
        > 
        > [(Click here if you wanna know more about ADB)](https://developer.android.com/tools/adb)
        > 
        > ### Connect your phone to your PC
        > 
        > Use a USB cable to connect your phone to your PC
        > 
        > ### Execute this command on PC
        > On Windows open Powershell in the directory with the adb.exe (where you unzipped it, if you didn't add it to the PATH)
        > 
        > On Unix open a shell in the directory with the adb (where you unzipped it, if you didn't add it to the PATH)
        > 
        > To test if this is working type `adb devices`, this should output a device
        > 
        > Then execute this command `adb shell logcat --pid $(adb shell "timeout 5s logcat | sed -En 's/.*com.jerboa.*, PID: (\S*)/\1/p'| tail -1")`
        > The above command will print the logs of the latest execution of Jerboa (regardless of which version/build).
        > 
        > That should look like something like this.
        > ![example_cmd](../../media/example_cmd.png)
        > 
        > Copy the full output. (If not possible just include the few lines below `FATAL EXCEPTION: main` )
        > 
        > Either include it as a file or paste it in the textarea above
        > 
        </details>

        **<details><summary>FOR GENERAL CRASHES (Click to expand)</summary>**
        > 
        > Follow these steps (skip the ones you already have done):
        > 
        > - Open Jerboa
        > - Go to 'Settings'
        > - Go to 'About'
        > - Go to 'Crash Logs'

        </details>