1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-20 03:51:18 +00:00
conky/.github/ISSUE_TEMPLATE/bug_report.yml
2022-10-04 08:56:44 -05:00

81 lines
2.3 KiB
YAML

name: 🐞 Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! If you haven't
done so already, please take a moment to search the existing issues to
see if this has been previously reported. If not, carry on.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see! Include screenshots if you have 'em.
value: "A bug happened!"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of Conky are you running?
validations:
required: true
- type: input
id: os
attributes:
label: What OS/distro are you seeing the problem on?
- type: textarea
id: config
attributes:
label: Conky config
description: Paste your Conky config here if it's relevant.
render: Lua
- type: markdown
attributes:
value: |
If you want to report a crash, please attach a stack trace.
To create one with `gdb`, try the following steps:
```shell
# Start 'conky'
$ gdb conky
# Run 'conky' with a config.
(gdb) run -c ~/.your_conky.conf
# Wait for a crash to occur, then run this.
(gdb) bt full
# ... stack trace output here ...
```
We want that backtrace inside `gdb` triple backticks.
```gdb
$ gdb conky
GNU gdb (GDB) 8.2
Copyright (C) 2018 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
...
```
- type: textarea
id: stacktrace
attributes:
label: Stacktrace
description: Paste your stacktrace here, if required.
render: Shell
- 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.
render: Shell