Improve issue templates

* Add template for other issues so it doesn't look like bug reports and
  feature requests are the only options
* Encourage users to read the README before filing issues
* Clarify that issues about specific operating systems and tooling are out
  of scope
This commit is contained in:
Martchus 2023-02-03 14:23:00 +01:00
parent 6e51839fba
commit 734fc170a4
3 changed files with 78 additions and 3 deletions

View File

@ -1,12 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
about: Report an existing feature not working as designated
title: ''
labels: bug
assignees: ''
---
**Before reporting, please have a look at "[Known bugs and workarounds](https://github.com/Martchus/syncthingtray/blob/master/README.md#known-bugs-and-workarounds)".**
Note that I cannot support all operating systems, their flavors and different
tooling you might be using (Anti Virus scanners, GNU/Linux desktop environments,
AUR helpers, …). So please avoid filing bug reports specific to them and contact
the respective vendors instead.
Note that adaptions for newer versions of certain platforms (or for completely
new platforms) would be *feature requests* and **not** bugs. So for instance,
making Syncthing Tray work under an updated/new GNU/Linux desktop environment
should be filed as a feature request and *not* a bug report.
Note that I will likely have to reject bug reports about Wayland-specific
problems due to limitations of that protocol which I cannot workaround from my
side.
---
**Relevant components**
* [ ] Standalone tray application (based on Qt Widgets)
* [ ] Plasmoid/applet for Plasma desktop
@ -17,7 +35,7 @@ assignees: ''
**Environment and versions**
* Versions of `syncthingtray`, `qtutilities` and `c++utilities`: …, …, …
* Qt version: 5.….…
* Qt version: .….…
* C++ compiler (name and version): …
* C++ standard library (name and version): …
* Operating system (name and version): …

View File

@ -2,11 +2,26 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature request
labels: feature request
assignees: ''
---
**Please browse through the [README](https://github.com/Martchus/syncthingtray/blob/master/README.md) before asking a question.**
Maybe what you've been asking is already implemented
or a known limitation with a documented workaround.
Note that I cannot support all operating systems, their flavors and different
tooling you might be using (Anti Virus scanners, GNU/Linux desktop environments,
AUR helpers, …). So please avoid filing feature requests specific to them and
contact the respective vendors instead.
Note that I will likely have to reject feature reports about Wayland-specific
behavior due to limitations of that protocol which I cannot workaround from my
side.
---
**Relevant components**
* [ ] Standalone tray application (based on Qt Widgets)
* [ ] Plasmoid/applet for Plasma desktop

42
.github/ISSUE_TEMPLATE/other_issue.md vendored Normal file
View File

@ -0,0 +1,42 @@
---
name: Other issue
about: Ask a question or file an issue that doesn't fit into the other categories
title: ''
labels:
assignees: ''
---
**Please browse through the [README](https://github.com/Martchus/syncthingtray/blob/master/README.md) before asking a question.**
Most likely your question is already answered.
Before asking questions about the AUR package, please read the [pinned comment
on the AUR](https://aur.archlinux.org/packages/syncthingtray#comment-568348).
Note that I cannot give concrete help for all operating systems, their flavors
and different tooling you might be using (Anti Virus scanners, GNU/Linux desktop
environments, AUR helpers, …). So if you want concrete advice about those you
must ask the respective vendors instead.
---
**Relevant components**
* [ ] Standalone tray application (based on Qt Widgets)
* [ ] Plasmoid/applet for Plasma desktop
* [ ] Dolphin integration
* [ ] Command line tool (`syncthingctl`)
* [ ] Integrated Syncthing instance (`libsyncthing`)
* [ ] Backend libraries
**Is your feature request specific to a certain platform/environment? Please specify.**
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Eg. I'm always frustrated when […]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.