bug issue template improvements #8894
Conversation
rszyma
force-pushed
the
improve-bug-template
branch
from
8a3e524 to
46dc48f
Compare
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - type: markdown | ||
| attributes: | ||
| value: >- | ||
| Please be sure to upload the following files below: |
There was a problem hiding this comment.
if they are relevant to the issue. Not all bugs are crashes
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| value: >- | ||
| Please be sure to upload the following files below: | ||
| - Logs can be found in $XDG_RUNTIME_DIR/hypr |
There was a problem hiding this comment.
you can add a hint to (sort by date to grab the latest)
| When including text files (such as logs or config), please **always ATTACH** them, and not paste them directly. | ||
| <u>This is important</u> because pasting text directly clutters the issue with unnecessary keywords, making github issue search useless. |
There was a problem hiding this comment.
too long. "This is important to avoid clutter, spam, and make the issues more readable".
There was a problem hiding this comment.
I really wanted to include this line explaining why exactly it's a problem, and not just say "it's better trust me bro". Otherwise someone will question it "I'm too lazy to put it in file first, how is copy-pasting a spam anyway? If it's too long I'll put it in dropdown" you get the idea
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| description: | | ||
| Paste the output of `hyprctl systeminfo -c` here. If you can't | ||
| Paste the output of `hyprctl systeminfo` here. If you can't | ||
| launch Hyprland, paste the output of `Hyprland --systeminfo`. | ||
| If `Hyprland --systeminfo` errors out (added in 0.44.0), find |
There was a problem hiding this comment.
we can remove this line by now. 0.44 is mega old
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| @@ -5,10 +5,10 @@ body: | |||
| - type: checkboxes | |||
| attributes: | |||
| label: Already reported ? * | |||
| description: Before opening a new bug report, please take a moment to search through the current open and closed issues to check if it already exists. | |||
| description: Before opening a new bug report, please take a moment to search through the current open issues. If same bug is already reported, don't open new issue - instead go upvote/comment on existing one. | |||
There was a problem hiding this comment.
if the same bug ...
comment on an existing one
Describe your PR, what does it fix/add?
Attempts to remedy #8893 by bringing back attaching as primary way of sending text files (logs, crashes, config).
Just so everbody reading this know, we used to have bug template that incentivized attaching instead of pasting, but it was not really effective. Anyway it was changed in #6160 so that user always pastes full config in plain text, and the issue search clutter began because of that.
Compared to before #6160, hopefully now it's clearer that before that every text file must be attached.
Also added more variants to "is it regression" dropdown, now I feel like response from that field will be more useful.
rendered issue looks like this:
template looks like this:
Is there anything you want to mention? (unchecked code, possible bugs, found problems, breaking compatibility, etc.)
nope
Is it ready for merging, or does it need work?
potentially needs more discussion, but I went a couple of iterations myself and now I feel like it's good now as is