diff options
Diffstat (limited to 'ISSUE_TEMPLATE.md')
-rw-r--r-- | ISSUE_TEMPLATE.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..5f3bb6bb --- /dev/null +++ b/ISSUE_TEMPLATE.md | |||
@@ -0,0 +1,34 @@ | |||
1 | If you are using the nvidia proprietary driver for any reason, you have two choices: | ||
2 | |||
3 | 1. Uninstall it and use nouveau instead | ||
4 | 2. Use X11+i3 and close your browser tab | ||
5 | |||
6 | If `lsmod | grep nvidia | wc -l` shows anything other than zero, your bug report is not welcome here. | ||
7 | |||
8 | Otherwise, please include the following four components in your bug report: sway version, debug log, configuration (if applicable), and an explanation of steps taken to reproduce the issue. | ||
9 | |||
10 | Obtain your version like so: | ||
11 | |||
12 | swaymsg -t get_version | ||
13 | |||
14 | If this doesn't work, use: | ||
15 | |||
16 | sway -v | ||
17 | |||
18 | * Sway Version: | ||
19 | |||
20 | Obtain a debug log like so: | ||
21 | |||
22 | sway -d 2> ~/sway.log | ||
23 | |||
24 | This will record information about sway's activity when it's running. Briefly reproduce your problem and exit sway. When preparing a debug log, brevity is important - start up sway, do the minimum work necessary to reproduce the error, then close sway. | ||
25 | |||
26 | Upload the debug log to a pastebin service such as [gist.github.com](https://gist.github.com), and link to it below. | ||
27 | |||
28 | * Debug Log: | ||
29 | |||
30 | You should try to reproduce the issue with the default configuration. If you cannot, please reproduce with a minimal configuration, upload the config to a pastebin service, and link to it below. | ||
31 | |||
32 | * Configuration File: | ||
33 | |||
34 | Finally, explain the steps you took in plain English to reproduce the problem below. | ||