chore(issue-template): improve correctness, privacy, and comprehensiveness (#606)

* chore(bug_template): improve correctness, privacy, and comprehensiveness

* chore(bug_template): fix syntax errors

* chore(bug_template): move MD links to MD section

They didn't render as intended

* chore(bug_template): clarify logfile
This commit is contained in:
Ricardo Fernández Serrata 2024-09-10 16:29:34 -04:00 committed by GitHub
commit 2a1ebbaa1d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,6 +7,14 @@ body:
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Wherever you see "If relevant", you can omit the field, if you prefer privacy.
If we believe it's relevant to the bug, we may later ask you to fill the info.
Examples:
- If your OS is Windows or Mac, then [WM](https://en.wikipedia.org/wiki/Window_manager)/[WS](https://en.wikipedia.org/wiki/Windowing_system) and [DE](https://en.wikipedia.org/wiki/Desktop_environment) are irrelevant, because it's implied by the OS.
- If the bug is related to ADB, then it's unlikely to be related to GUI, DE, or WM. No need to specify them.
- If you use the latest-stable official version of any software (such as a [distro](https://en.wikipedia.org/wiki/Linux_distribution)), you can omit the version number.
- type: textarea
id: what-happened
attributes:
@ -27,32 +35,39 @@ body:
label: You have a solution?
description: What to do to fix the issue.
- type: dropdown
id: os
id: kernel # technically accurate
attributes:
label: Operating System
options:
- Linux
- MacOS
- Windows
- MacOS # Darwin+XNU
- Windows # NT
validations:
required: true
- type: input
id: wm
id: os-v
attributes:
label: Window Manager
description: Please, fill it if OS is Linux
placeholder: Wayland, xorg, etc...
label: Distro version
description: If relevant, please fill it
placeholder: Win11 Home, Debian 12, etc...
- type: input
id: ws-and-wm
attributes:
label: Window System + Manager
description: If relevant, please fill it
placeholder: Wayland 1.23 + Mutter 46, xorg + i3, etc...
- type: input
id: de
attributes:
label: Desktop Environment
description: Please, fill it if OS is Linux
description: If relevant, please fill it
placeholder: GNOME 46, KDE Plasma 4, etc...
- type: textarea
id: logfiles
attributes:
label: Provide logs
description: Upload the logfile generated by UAD-ng. See https://github.com/Universal-Debloater-Alliance/universal-android-debloater-next-generation/wiki/FAQ#where-are-the-logfiles for the location of logfiles.
description: "Paste the relevant (notice the line timestamps) slice (contiguous range) of [the logfile generated by UAD-ng](https://github.com/Universal-Debloater-Alliance/universal-android-debloater-next-generation/wiki/FAQ#where-are-the-logfiles)"
render: "" # this should disable soft-wrap
validations:
required: true
@ -60,7 +75,7 @@ body:
id: acknowledgements
attributes:
label: Acknowledgements
description: Your bug report will be closed if you don't follow the checklist below.
description: "Your bug report will be closed if you don't follow the checklist below."
options:
- label: This issue is not a duplicate of an existing bug report.
required: true