nheko/.github/ISSUE_TEMPLATE/bug_report.yaml

151 lines
4.2 KiB
YAML
Raw Normal View History

2021-08-08 01:17:31 +02:00
name: Bug Report
description: Create a report to help us improve
#title: "[Bug]: "
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
2021-08-08 01:20:10 +02:00
Please try to fill out all fields to the best of your ability.
2021-08-08 01:17:31 +02:00
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: Enter your description here.
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: To Reproduce
2021-08-08 01:21:29 +02:00
description: Steps to reproduce the behavior.
2021-08-08 01:17:31 +02:00
placeholder: |
2021-08-08 01:20:10 +02:00
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
2021-08-08 01:17:31 +02:00
value: |
2021-08-08 01:20:10 +02:00
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
2021-08-08 01:17:31 +02:00
validations:
required: true
- type: textarea
id: behaviour
attributes:
label: What happened?
description: A clear and concise description of what actually happened.
validations:
required: false
- type: textarea
id: expected-behaviour
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
2021-08-08 01:20:10 +02:00
placeholder: Upload your screenshots here. You can paste them or click on "Attach files".
2021-08-08 01:17:31 +02:00
validations:
required: false
- type: input
id: version
attributes:
label: Version
description: Get the version from the settings menu (bottom left corner)
2021-08-08 01:20:10 +02:00
placeholder: 0.0.1-deafbeef
2021-08-08 01:17:31 +02:00
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
multiple: true
options:
- Linux
- macOS
- Windows
- BSD
2021-08-08 01:20:10 +02:00
- Haiku
- Other
2021-08-08 01:17:31 +02:00
- type: dropdown
2021-08-08 01:23:27 +02:00
id: install-method
2021-08-08 01:17:31 +02:00
attributes:
label: Installation method
multiple: true
options:
- Flathub
- Flatpak nightly repo or download
- AppImage
- Windows download
- macOS DMG file
2021-08-08 01:20:10 +02:00
- Some repository (AUR, homebrew, distribution repository, PPA, etc)
- Local build
2021-08-08 01:17:31 +02:00
- type: input
id: qt-version
attributes:
label: Qt version
description: What version of Qt does your system use? (If you compiled Nheko yourself.)
2021-08-08 01:20:10 +02:00
placeholder: 5.15.2.
2021-08-08 01:17:31 +02:00
validations:
required: false
- type: input
id: compiler
attributes:
label: C++ compiler
description: What compiler (and version) did you use (if you compiled Nheko yourself)?
2021-08-08 01:20:10 +02:00
placeholder: gcc-9000
2021-08-08 01:17:31 +02:00
validations:
required: false
- type: input
id: de
attributes:
label: Desktop Environment
description: If you are on Linux, describe your desktop environment.
2021-08-08 01:20:10 +02:00
placeholder: KDE with i3 as the window manager
2021-08-08 01:17:31 +02:00
validations:
required: false
- type: checkboxes
id: profiles
attributes:
label: Did you use profiles?
description: Usually by passing the --profile command line parameter. If you don't know, answer 'no'.
options:
- label: Profiles used?
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
2021-08-08 01:20:10 +02:00
placeholder: |
The log file is located in
Linux: ~/.cache/nheko/
macOS: ~/Library/Caches/nheko or /Library/Caches/nheko
Windows: C:/Users/<USER>/AppData/Local/nheko/cache
2021-08-08 01:17:31 +02:00
render: shell
- type: textarea
id: backtrace
attributes:
label: Backtrace
description: If the program crashed send a backtrace.
2021-08-08 01:20:10 +02:00
placeholder: |
You can retrieve a backtrace by building nheko with -DCMAKE_BUILD_TYPE=Debug and running it through gdb or lldb.
2021-08-08 01:17:31 +02:00
2021-08-08 01:20:10 +02:00
gdb ./build/nheko
2021-08-08 01:17:31 +02:00
2021-08-08 01:20:10 +02:00
>> run
2021-08-08 01:17:31 +02:00
2021-08-08 01:20:10 +02:00
... Make the program crash
2021-08-08 01:17:31 +02:00
2021-08-08 01:20:10 +02:00
>> bt
2021-08-08 01:17:31 +02:00
render: shell