-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
[Improvement] Issue Template Proposal #3483
Conversation
Allows for a standard way for Issues to be asked. This helps contributors with finding a solution to problem
Codecov Report
@@ 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. |
59af733
to
865ed16
Compare
0004b37
to
3e801b3
Compare
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. |
069314a
to
181c68f
Compare
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. |
3033aaf
to
2a9c666
Compare
3cd84a5
to
614f285
Compare
Looks great! Can the field names be more of markdown and less of an identifier? like "node version" etc |
1cd6940
to
a1333a6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Hey @ljharb, I tried create an issue to test the template. I noticed backticks on the labels.
I think .yml file has trouble reading this which causes this error:
Currently the when trying to create an issue, this issue template is inaccessible and defaults to the original blank issue format. |
oh whoops. i added them last minute to try to make it format like backticked text does. i'll remove them. |
Try now? |
Looks good now! |
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:
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:
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!