Skip to content

Commit e2105fd

Browse files
committed
Provide more thorough bug-report instructions
1 parent 1e6f20b commit e2105fd

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,23 @@ these instructions:
1212
- **Version:**
1313
- Run this command: `wayvnc -V`
1414

15-
- Try to reproduce while capturing a **trace log:**
16-
- `wayvnc -Ltrace | tee wayvnc-crash.log`
15+
- Provide context, including but not limited to
16+
- Command line arguments
17+
- Special environment variables, if any
18+
- jhich wayland compositor are you using? Which version?
19+
- What VNC client are you using?
20+
- Did you configure your VNC client in a specific manner?
21+
- Linux distro/operating system
22+
- Kernel version
23+
- Graphics drivers
1724

18-
- Get the **stack trace**:
19-
- If have `coredumpctl`, you can gather the stack trace after a crash using
20-
`coredumpctl gdb wayvnc` and then run `bt full` to obtain the stack trace.
25+
- Try to reproduce the problem while capturing a **trace log:**
26+
- `wayvnc -Ltrace | tee wayvnc-bug.log`
27+
28+
- Get the **stack trace**, in case of a crash:
29+
- If you have `coredumpctl`, you can gather the stack trace after a crash
30+
using `coredumpctl gdb wayvnc` and then run `bt full` to obtain the stack
31+
trace.
2132
- Otherwise, you can either locate the core file and load it into gdb or run
2233
wayvnc in gdb like so:
2334
- `gdb --args wayvnc -Ltrace`
@@ -26,3 +37,6 @@ these instructions:
2637
again.
2738

2839
- Describe how to **reproduce** the problem
40+
41+
- Try to think about your problem beyond these instructions and include
42+
whatever information that you believe will help to resolve the issue

0 commit comments

Comments
 (0)