diff options
author | Brian Ashworth <bosrsf04@gmail.com> | 2020-07-06 17:18:47 -0400 |
---|---|---|
committer | Simon Ser <contact@emersion.fr> | 2020-07-06 23:30:14 +0200 |
commit | bac9559665bc908e4f61a6405a6ce5109956f4a3 (patch) | |
tree | 29117183b2dc3be771cb53da8f5012fa02440cec /.github | |
parent | 1d149230ea1fbe7bc5ac906e235db3c1fdc63afa (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')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 33 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 5 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/enhancement.md | 13 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/i3_compat.md | 20 |
4 files changed, 71 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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..f09cdf5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions + url: "http://webchat.freenode.net/?channels=sway&uio=d4" + about: "Please ask questions on IRC in #sway on irc.freenode.net" diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..3ed45b01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,13 @@ +--- +name: Enhancements +about: New functionality +labels: 'enhancement' + +--- + +### Please read the following before submitting: +- We are not accepting any new window management features unless they get implemented by i3. Please consider searching for or opening an i3 feature request. + +### Please fill out the following: +- **Description:** +Please describe in plain English what the enhancement is and what the use case is. diff --git a/.github/ISSUE_TEMPLATE/i3_compat.md b/.github/ISSUE_TEMPLATE/i3_compat.md new file mode 100644 index 00000000..4dfa21c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/i3_compat.md @@ -0,0 +1,20 @@ +--- +name: i3 Compatibility +about: Sway behaves differently from or lacks i3 functionality +labels: 'i3-compat' + +--- + +### Please read the following before submitting: +- The following either do not make sense for Wayland or we have decided against supporting: + - `restart` + - `resource` + - saving and loading layouts + - the i3 sync protocol + +### Please fill out the following: +- **i3 PR:** + - If this is new i3 functionality, please add a link to the i3 pull request. + +- **Description:** + - Please describe in plain English how Sway and i3's behaviors differ or what functionality Sway is lacking. |