mirror of
https://github.com/swaywm/sway.git
synced 2024-11-21 23:41:27 +00:00
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.
This commit is contained in:
Brian Ashworth
Simon Ser
parent
1d149230ea
commit
bac9559665
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -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.
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -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"
|
||||||
13
.github/ISSUE_TEMPLATE/enhancement.md
vendored
Normal file
13
.github/ISSUE_TEMPLATE/enhancement.md
vendored
Normal file
|
|
@ -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.
|
||||||
20
.github/ISSUE_TEMPLATE/i3_compat.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/i3_compat.md
vendored
Normal file
|
|
@ -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.
|
||||||
|
|
@ -1,48 +0,0 @@
|
||||||
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.
|
|
||||||
|
|
||||||
If you are using the Nvidia proprietary driver for any reason, you have two choices:
|
|
||||||
|
|
||||||
1. Uninstall it and use nouveau instead
|
|
||||||
2. Use X11+i3 and close your browser tab
|
|
||||||
|
|
||||||
If `lsmod | grep nvidia | wc -l` shows anything other than zero, your bug report is not welcome here.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Obtain your version like so:
|
|
||||||
|
|
||||||
swaymsg -t get_version
|
|
||||||
|
|
||||||
If this doesn't work, use:
|
|
||||||
|
|
||||||
sway -v
|
|
||||||
|
|
||||||
* Sway Version:
|
|
||||||
|
|
||||||
Obtain a debug log by running the following command from a TTY:
|
|
||||||
|
|
||||||
sway -d 2> ~/sway.log
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Upload the debug log to a pastebin service such as [gist.github.com](https://gist.github.com), and link to it below.
|
|
||||||
|
|
||||||
* Debug Log:
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
* Configuration File:
|
|
||||||
|
|
||||||
Finally, explain the steps you took in plain English to reproduce the problem below.
|
|
||||||
|
|
||||||
* Stack Trace, if sway crashes:
|
|
||||||
|
|
||||||
If you use systemd, you should be able to open the coredump of the most recent crash with GDB like so:
|
|
||||||
|
|
||||||
coredumpctl gdb sway
|
|
||||||
|
|
||||||
And then type `bt full` to obtain the stack trace.
|
|
||||||
|
|
||||||
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.
|
|
||||||
Loading…
Reference in a new issue