aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.md
diff options
context:
space:
mode:
authorBrian Ashworth <bosrsf04@gmail.com>2020-07-06 17:18:47 -0400
committerSimon Ser <contact@emersion.fr>2020-07-06 23:30:14 +0200
commitbac9559665bc908e4f61a6405a6ce5109956f4a3 (patch)
tree29117183b2dc3be771cb53da8f5012fa02440cec /.github/ISSUE_TEMPLATE/bug_report.md
parent1d149230ea1fbe7bc5ac906e235db3c1fdc63afa (diff)
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 '.github/ISSUE_TEMPLATE/bug_report.md')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..4e4f6a77
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,33 @@
+---
+name: Bugs
+about: Crashes and other bugs
+labels: 'bug'
+
+---
+
+### Please read the following before submitting:
+- Please do NOT submit bug reports for questions. Ask questions on IRC at #sway on irc.freenode.net.
+- Proprietary graphics drivers, including nvidia, are not supported. Please use the open source equivalents, such as nouveau, if you would like to use Sway.
+- Problems with the Wayland version of Firefox are likely to be Firefox bugs. Start by submitting your issue to the Firefox Bugzilla and come back here only after they confirm otherwise.
+
+### Please fill out the following:
+- **Sway Version:**
+ - `swaymsg -t get_version` or `sway -v`
+
+- **Debug Log:**
+ - Run `sway -d 2> ~/sway.log` from a TTY and upload it to a pastebin, such as gist.github.com.
+ - This will record information about sway's activity. Please try to keep the reproduction as brief as possible and exit sway.
+
+- **Configuration File:**
+ - Please try to produce with the default configuration.
+ - If you cannot reproduce with the default configuration, please try to find the minimal configuration to reproduce.
+ - Upload the config to a pastebin such as gist.github.com.
+
+- **Stack Trace:**
+ - This is only needed if sway crashes.
+ - If you use systemd, you should be able to open the coredump of the most recent crash with gdb with
+ `coredumpctl gdb sway` and then `bt full` to obtain the stack trace.
+ - If the lines mentioning sway or wlroots have `??` for the location, your binaries were built without debug symbols. Please compile both sway and wlroots from source and try to reproduce.
+
+- **Description:**
+ - The steps you took in plain English to reproduce the problem.