ISSUE_TEMPLATE: comment out example/help text #11891
Conversation
old non-supported version
|
when opening an issue, you see the Code not the Preview when opening an issue it looks like this
the change is only for the preview, so when the issue is opened it doesn't look like this
it looks like this
|
There was a problem hiding this comment.
The idea to comment out the help text is good but since we are at it how about simplifying the bug-report template to only have the General Description section, or maybe even leave it completely blank, because most of the time when users open issues they never fill the other sections.
| @@ -6,7 +6,7 @@ about: Report a bug | |||
|
|
|||
| ### General Description | |||
|
|
|||
| A clear and concise description of what the bug is. | |||
| <!-- A clear and concise description of what the bug is. --> | |||
|
|
|||
| ### How To Reproduce? | |||
There was a problem hiding this comment.
The steps example below could be also commented out here.
| ``` | ||
| Insert Your Logs Here | ||
| ``` |
There was a problem hiding this comment.
This could be commented out too.
There was a problem hiding this comment.
no because the the logs should be pasted there.
when you comment it out, then it's not shown...
There was a problem hiding this comment.
Most of issue openers don't use any of those, that's the motive for this PR in the first place right?
There was a problem hiding this comment.
no.
if logs don't get entered (while applicable) that's a problem of the person filling it in "incorrectly", it's not a problem of the template itself
I would also go into this direction. We could have the template like this: Provide a general description of your problem with relevant information such as Operating System, Wasabi Version, Screenshot, Logs... |
nack, current issue template works fine, I don't see a reason to change it. |
|
Please comment |
why? |
Isn't it the whole point of your PR? You are commenting out some parts but not everything without any apparent reason. Both information "needs to be filled in". |
|
Ok, I understood your point. "needs to be filled in", you mean "required". Well, in this case, isn't the whole PR wrong? Because ALL the information is "required". Knowing Wasabi's version is equally important as knowing the reproduction steps, otherwise, we have to ask "are you sure you are on the latest version?" Same goes for the OS. So, for me, both the concept and the implementation are questionable at best, and wrong at worst. Anyway, it seems Yahia and I are the only ones who don't like it, and I don't care enough to really fight that so @adamPetho, if you think everything is good please merge. |
no not really. where as other steps user should just type in and the text is only as example/help. |
|
I have no idea what's going on under this PR. All I know is that I would rather see an issue with minimal user provided text than having to decypher the useful information out of the placeholder texts. This is why I approved this PR in the first place. @yahiheb @turbolay Guys, if you feel this is horrible and there are clear issues, please point them out or suggest fixes. If I see no fights/NACKs under this PR until tomorrow, I will merge it. Thanks. |
|
#11971 is a very good example that in practice the The advanced users who know the importance of proving more information and know how to get it, usually do that by themselves. My solution to make the issues easy to read for us is to simplify the |
|
This goes in the right direction, but please find common ground with the guys. Thanks. |
Over time, several people who opened an issue didn't remove the help/example text.
So it was shown when reading the issue.
Commenting it out makes the issue look better and easier to read, when the issue opener doesn't remove it.