-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Issue template update #6158
Issue template update #6158
Conversation
Signed-off-by: Manuel Del Real <[email protected]>
Signed-off-by: Manuel Del Real <[email protected]>
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.
A couple minor things. Also, should we add a config.yml
to point to other places to get help, and should we disable blank issues? See https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
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.
One thing I've been considering with these templates, is changing the instructions to use comment blocks rather than markdown. If we do that, then the submitter won't need to delete the instructions or blocks that aren't appropriate to them.
I'll also +1 @aldeed's suggestion to disable blank issues.
…onfig.yml to disable blank issues Signed-off-by: Manuel Del Real <[email protected]>
… into issue_template
Signed-off-by: Manuel Del Real <[email protected]>
Signed-off-by: Manuel Del Real <[email protected]>
Signed-off-by: Manuel Del Real <[email protected]>
Signed-off-by: Manuel Del Real <[email protected]>
Signed-off-by: Manuel Del Real <[email protected]>
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.
Looks good to me 👍
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.
LGTM. Let's see how it works and make changes if necessary.
Issue
In line with our proposed bug triage process, this is an easier way to identify new issues and differentiate them from core work
Solution
The issue template is being split into three different templates: one for bugs, one for core work and another for questions. Inspiration taken from Facebook's Docusaurus repo (https://github.com/facebook/docusaurus/tree/master/.github/ISSUE_TEMPLATE)
Issues created with each template will be properly tagged upon creation, making them easier to identify for bug triage, deletion or core work tracking.
Breaking changes
none
Testing
Create a new issue and pick a template