Update the bug report template #409
Conversation
rephrased some stuff and changed the label used for reports to an original one.
Change instructions to ask for current description of the world, rather than the ideal state as per offline discussion
should/shouldn't we use this style? we should.
|
I still object with the requirement of "desired state" in a bug report title. From the perspective of an outsider who just comes here and files a bug report, it's typical for the title to be written as a "the current state" like how other projects allows/typical done (can just pick out chromium, firefox, etc...) and this "Make sure..." text could even easily be glossed over. |
|
I'm not sure I understand the second approach you recommend, does "use either should or should not phrasing" not fulfill "have a guideline for both style of title"? @nullsystem |
|
@blaberry It's about "desired" vs "current" state of title phrasing. "should/should not" is a single "desired" style phrasing. |
|
Right, then we run into the issue we discussed at length over chat, where some items are desired state, some are not, and the mishmash of both will most likely turn out much harder to read than what's on offer in this PR |
|
@blaberry There's an important distinction between a bug, change request (opinionated, current state isn't a bug), and feature request. There shouldn't be a blanket all of those have same "desired" state titles, and what the current template have currently also gives a clearer distinction with the "[BUG] " title prefix even. The "desired" state titles are natural gravitation for change/feature requests, but as I've put it, the "current" state titles are natural gravitation for bug reports. It's not really a case of random some are/some are not thing, it's that there are distinction that issues titles written for bugs are done differently to change/feature requests. |
|
Alright so two different topics: using a tag in the title: labels in Github are meant to categorize issues for easier filtering and searching. "[BUG]" in the title achieves a similar purpose, but it clutters the title and reduces readability. I added a new label to make this clearer. We can also add a label for FRs. title formatting: I'll revert the title format instructions to how it was before since we can't find consensus on this. |
Replace them with describing what is wrong, instead of specifying what ought to be.
* Update the bug report template rephrased some stuff and changed the label used for reports to an original one. * Update bug_report.yml Change instructions to ask for current description of the world, rather than the ideal state as per offline discussion * Imperative bug report template should/shouldn't we use this style? we should. * Remove imperative and should/shouldn't instructions Replace them with describing what is wrong, instead of specifying what ought to be. * Set non null placeholder title. * Remove title, might fix submit without title issues
rephrased some stuff and changed the label used for reports to an original one.
Description
Toolchain
Linked Issues