language-tools icon indicating copy to clipboard operation
language-tools copied to clipboard

chore: add issue template

Open gegoune opened this issue 3 months ago • 3 comments

Hi @johnsoncodehk,

I have been astounded with quality of issue reports here following 2.0 release. I believe having issue template will help a bit by requiring users to put effort into high quality issues with replication steps and all other required information so maintainers and contributors don't have to do extra legwork.

This PR creates example issue template coming from documentation and is intended to check whether you would be interested in implementing it at all. If so we can change the template to fit this repositories' requirements.

gegoune avatar Mar 12 '24 17:03 gegoune

https://twitter.com/johnsoncodehk/status/1649825147753488384

But I agree that there are too many low-quality bug reports

so1ve avatar Mar 13 '24 01:03 so1ve

https://twitter.com/johnsoncodehk/status/1649825147753488384

I don't get that point. A consistent structure to the reports would help to process the reports. The report is not meant to be a place to express myself but provide concise information that help with fixing the issue.

Also having a codesandbox (or whatever is cool these days) that users could fork would simplify reporting.

I would consider myself a more advanced user and would often provide reproduction (or even a fix) but I would still prefer to follow a template when reporting than having to think about how to write it myself.

rchl avatar Mar 13 '24 07:03 rchl

maybe the file name should be .github/ISSUE_TEMPLATE/bug_report.yml instead of .github/ISSUE_TEMPLATE

and more information can be configured in .github/ISSUE_TEMPLATE/config.yml

lisonge avatar Mar 17 '24 16:03 lisonge