Skip to content

Updated bug report template: moved Context to the top #20429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2023

Conversation

Stan-vw
Copy link
Contributor

@Stan-vw Stan-vw commented Mar 8, 2023

The idea of this change is that people can write tickets the way they naturally do (starting with the context) and then answering the point-blank questions like expected behaviour more concisely. After a few weeks of triaging hundreds of reports, I noticed people often start off their bug reports with a story on what went wrong, where they were etc. This is all context that is currently often put into other sections (such as "Expected behaviour" which was on the top).

Note: I also updated the shop@matomo.org email address, which is now the preferred email address.

The idea of this change is that people can write tickets the way they naturally do (starting with the context) and then answering the point-blank questions like expected behaviour more concisely.
After a few weeks of triaging hundreds of reports, I noticed people often start off their bug reports with a story on what went wrong, where they were etc. This is all context that is currently often put into other sections (such as "Expected behaviour" which was on the top).
@sgiehl
Copy link
Member

sgiehl commented Mar 8, 2023

@Stan-vw Guess that makes sense. As a further improvement we actually could consider to move that to using forms instead, to make it easier for a reporter to fill it in. The comment stuff we currently have is not that much usable.
An example for the forms feature can be seen here: https://github.com/materializecss/materialize/issues/new?assignees=&labels=bug&template=bug.yml&title=%5BBug%5D%3A+

@Stan-vw
Copy link
Contributor Author

Stan-vw commented Mar 9, 2023

That's pretty fancy!
Not sure if it's definitely easier to use though. Yes it splits it up clearly with less raw text, but it adds some clicking/tabbing to jump from input field to input field, plus the action of clicking the tickboxes at the top. Would you expect these changes to be a hurdle to a certain percentage of bug reports not happening as a result of these extra steps, or should we expect the same amount of bug reports with it?

@sgiehl
Copy link
Member

sgiehl commented Mar 9, 2023

@Stan-vw That was just an example. The forms can be designed using yml files. We don't need to add any checkboxes. I think a form would make it more clear what to fill in. And it might maybe even avoid some issue where people simply remove the whole template in order to place a question they actually should ask on the forum.

Copy link
Contributor

@bx80 bx80 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bx80 bx80 merged commit c248022 into matomo-org:4.x-dev Mar 10, 2023
@sgiehl sgiehl added this to the 4.14.0 milestone Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants