alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
swayfx/.github/ISSUE_TEMPLATE/bug_report.md

35 lines
1.7 KiB
Markdown
Raw Normal View History

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.
2020-07-07 07:18:47 +10:00
---
name: Bugs
about: Crashes and other bugs
labels: 'bug'
---
### Please read the following before submitting:
- Proprietary graphics drivers, including nvidia, are not supported. Please use the open source equivalents, such as nouveau, if you would like to use Sway.
Fix typo in bug reporting template
2021-01-26 18:10:44 +11:00
- Please do NOT submit issues for information from the github wiki. The github wiki is community maintained and therefore may contain outdated information, scripts that don't work or obsolete workarounds.
ISSUE_TEMPLATE: the wiki is community maintained Mention that the github wiki may contain outdated information scripts and old workarounds and that sway the sway project does not provide support for it.
2020-12-18 21:06:21 +11:00
If you fix a script or find outdated information, don't hesitate to adjust the wiki page.
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.
2020-07-07 07:18:47 +10:00
### Please fill out the following:
updated issue template
2022-08-17 12:08:37 +10:00
- **Swayfx Version:**
- `sway -v`
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.
2020-07-07 07:18:47 +10:00
- **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.
github: don't truncate debug logs This happens a lot, the latest one is [1]. [1]: https://github.com/swaywm/sway/issues/6570
2021-10-03 01:37:06 +10:00
- Attach the **full** file, do not truncate it.
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.
2020-07-07 07:18:47 +10:00
- **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.
Reference in a new issue Copy permalink