diff options
-rw-r--r-- | ISSUE_TEMPLATE.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..21f0a36e --- /dev/null +++ b/ISSUE_TEMPLATE.md | |||
@@ -0,0 +1,27 @@ | |||
1 | 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. | ||
2 | |||
3 | Obtain your version like so: | ||
4 | |||
5 | swaymsg -t get_version | ||
6 | |||
7 | If this doesn't work, use: | ||
8 | |||
9 | sway -v | ||
10 | |||
11 | * Sway Version: | ||
12 | |||
13 | Obtain a debug log like so: | ||
14 | |||
15 | sway -d 2> ~/sway.log | ||
16 | |||
17 | 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. | ||
18 | |||
19 | Upload the debug log to a pastebin service such as [gist.github.com](https://gist.github.com), and link to it below. | ||
20 | |||
21 | * Debug Log: | ||
22 | |||
23 | 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. | ||
24 | |||
25 | * Configuration File: | ||
26 | |||
27 | Finally, explain the steps you took in plain English to reproduce the problem below. | ||