[Improvement] Issue Template Proposal

[ROSSROSALES]

Issue Template for Bugs

This Proposal is to improve the overall quality of how issues are presented and solved.
Issues presented with a standardized method should:

• improve understanding of problem
  • description and example
• reduce number of unnecessary clarifying questions to ask
  • "why do this?" or "can you show me an example?" or "Have you read X?"
• makes users creating an issue think if it's an issue that has not already been solved, or if this problem has been asked / answered before
  • Users presenting an issue can rethink their issue and possibly solve their problem by going through a checklist/process of submitting an issue through a template.

Discussion/Thoughts

When creating this template, it is important for the user to have incentive to submit an issue.
With that in mind, we want to make sure the template:

• not overwhelming with too much info to fill in
• is simple to understand
• taken inspiration from other used issue templates
• enough information is filled so that contributors aiming to solve issue would have to ask minimal questions

Goal / Conclusion

Issues that are presented by users are issues that users have tried to debug before submitting it.
First time / New contributors / Veteran contributors have a better background to tackle the issue.
Improve community contribution and participation through reducing barrier to entry for contributors and reducing maintainer time for minor matters (ie. asking redundant questions across issues to users in different time zones, waiting days for a reply)

There is always room for improvement, please let me know if I am missing any information that may be required or removed.
Thank you!

[codecov]

Codecov Report

Merging #3483 (1cd6940) into master (0a2f6b7) will not change coverage.
The diff coverage is n/a.

❗ Current head 1cd6940 differs from pull request most recent head a1333a6. Consider uploading reports for the commit a1333a6 to get more accurate results

@@           Coverage Diff           @@
##           master    #3483   +/-   ##
=======================================
  Coverage   97.57%   97.57%           
=======================================
  Files         130      130           
  Lines        9211     9211           
  Branches     3341     3341           
=======================================
  Hits         8988     8988           
  Misses        223      223           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ljharb]

This is great! Could we try using the form fields here? https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

Also, let's try to get the user's eslint config as well in a textarea.

[ROSSROSALES]

This is great! Could we try using the form fields here? https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

Also, let's try to get the user's eslint config as well in a textarea.

Thank you for the review Jordan! I will add the forms fields and add ESLint config so that we can have a better understanding of the user's settings.

[ROSSROSALES]

New issues template to support Github's beta form fields.
Below is a screenshot of how issues template is displayed to issue contributor

[ljharb]

Looks great! Can the field names be more of markdown and less of an identifier? like "node version" etc

[ROSSROSALES]

Screenshot of updated changes

[ljharb]

Thanks!

[ROSSROSALES]

Hey @ljharb, I tried create an issue to test the template. I noticed backticks on the labels.
For example:

eslint-plugin-react/.github/ISSUE_TEMPLATE/bug_report.yml

Line 64 in b4cab03

label: `eslint-plugin-react` version

I think .yml file has trouble reading this which causes this error:

YAML syntax error: (): found character that cannot start any token while scanning for the next token at line 64 column 14.

Currently the when trying to create an issue, this issue template is inaccessible and defaults to the original blank issue format.
What were the reason for the backticks?

[ljharb]

oh whoops. i added them last minute to try to make it format like backticked text does. i'll remove them.

[ljharb]

Try now?

[ROSSROSALES]

Looks good now!
Thanks for the prompt reply! I appreciate it.

[ljharb]

Thanks for catching it :-)