-
Notifications
You must be signed in to change notification settings - Fork 5.8k
New issue templates! #3400
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
New issue templates! #3400
Conversation
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.
Overall, these look great. I like the yaml-based presentation with fillable forms. It gives it more of a guided feel that (one hopes) will help encourage their use.
16c7ee7
to
d43cd33
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.
Couple o' missed comments, otherwise looks good.
UPDATE: I ended up deleting the |
70c70c5
to
5d24fb4
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.
Editorial comments
614496d
to
c7600f7
Compare
story link: #3295
context
Our team triages and actions issues created internally and externally; however, we feel that the current templates are outdated, bloated, and missing key details.
While we work out an "Life of an Issue" playbook (similar to the Life of a PR), it would really help to feel confident in the existing templates, which we lean on as a tool for user input and story creation.
data/anecdotes
Most issues created are for/by our team. Very few were created externally. See this table, which was pulled using this custom Python script that I wrote:
This image shows that most issues are created by our team:
This image shows that most issues are not created using a template.
Conclusion: MOST of our issues are created internally (likely via the Zenhub portal) and do NOT use templates (meaning that either the templates are poor AND/OR they "easy" workflow for creating issues doesn't allow for templates).
the user story
As a code examples engineer, I want a new set of issue templates to:
what's in this PR?
This PR:
testing
This was tested in my fork. Please see https://github.com/ford-at-aws/aws-doc-sdk-examples/issues/new/choose.
risk
This is a low-risk change that can easily be reverted in minutes without any impact to data or customer experience. The biggest risk is the possibility that this will create external friction that is invisible to our team.
notes for the reviewer
I expect there to be some comments on this, so please fire away! I'm happy to make any changes that add value.