diff options
author | 2020-07-06 17:18:47 -0400 | |
---|---|---|
committer | 2020-07-06 23:30:14 +0200 | |
commit | bac9559665bc908e4f61a6405a6ce5109956f4a3 (patch) | |
tree | 29117183b2dc3be771cb53da8f5012fa02440cec /ISSUE_TEMPLATE.md | |
parent | protocols: sync wlr-layer-shell-unstable-v1 with wlroots (diff) | |
download | sway-bac9559665bc908e4f61a6405a6ce5109956f4a3.tar.gz sway-bac9559665bc908e4f61a6405a6ce5109956f4a3.tar.zst sway-bac9559665bc908e4f61a6405a6ce5109956f4a3.zip |
ISSUE_TEMPLATE: Use the newer issue templates
This utilizes the newer Github issue templates. They allow for the user
to specify what type of issue they are submitting to allow for a more
specific issue template to be shown.
In addition to a hopefully easier to read/parse/follow bug report
template, this also include templates for enhancements and i3
compatibility. This also includes a link to the IRC under the section
title Questions.
For the three templates, the labels bug, enhancement, and i3-compat will
be automatically applied for the appropriate report to assist in
triaging.
Hopefully, this will result in less questions and issues for new window
management functionality on Github and allow for better quality issues
being submitted. At the very least, it allows us to outline our
stances for bugs, enhancements, and i3-compatibility in an easier to
read format.
Diffstat (limited to 'ISSUE_TEMPLATE.md')
-rw-r--r-- | ISSUE_TEMPLATE.md | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 4b715aeb..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null | |||
@@ -1,48 +0,0 @@ | |||
1 | If you want to ask a question, please check out the wiki. If you don't find an answer there, ask on IRC (#sway on irc.freenode.net). The issue tracker may not be used for questions. | ||
2 | |||
3 | If you are using the Nvidia proprietary driver for any reason, you have two choices: | ||
4 | |||
5 | 1. Uninstall it and use nouveau instead | ||
6 | 2. Use X11+i3 and close your browser tab | ||
7 | |||
8 | If `lsmod | grep nvidia | wc -l` shows anything other than zero, your bug report is not welcome here. | ||
9 | |||
10 | Additionally, problems with Firefox are almost certainly Firefox bugs, not sway bugs. Start by submitting your issue to the Firefox Bugzilla and come back here only after they confirm otherwise. | ||
11 | |||
12 | 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. If sway crashes, also include a stack trace. | ||
13 | |||
14 | Obtain your version like so: | ||
15 | |||
16 | swaymsg -t get_version | ||
17 | |||
18 | If this doesn't work, use: | ||
19 | |||
20 | sway -v | ||
21 | |||
22 | * Sway Version: | ||
23 | |||
24 | Obtain a debug log by running the following command from a TTY: | ||
25 | |||
26 | sway -d 2> ~/sway.log | ||
27 | |||
28 | 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. | ||
29 | |||
30 | Upload the debug log to a pastebin service such as [gist.github.com](https://gist.github.com), and link to it below. | ||
31 | |||
32 | * Debug Log: | ||
33 | |||
34 | 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. | ||
35 | |||
36 | * Configuration File: | ||
37 | |||
38 | Finally, explain the steps you took in plain English to reproduce the problem below. | ||
39 | |||
40 | * Stack Trace, if sway crashes: | ||
41 | |||
42 | If you use systemd, you should be able to open the coredump of the most recent crash with GDB like so: | ||
43 | |||
44 | coredumpctl gdb sway | ||
45 | |||
46 | And then type `bt full` to obtain the stack trace. | ||
47 | |||
48 | If the lines mentioning sway/wlroots have "??" for the location, your binaries were built without debug symbols, and the stack trace is unlikely to be useful. You can find instructions to compile sway from source [here](https://github.com/swaywm/sway/wiki/Development-Setup#compiling-as-a-subproject). Note that debug symbols are included in Meson builds by default. | ||