aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

New issue templates!

Open ford-at-aws opened this issue 2 years ago • 1 comments

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:

image

This image shows that most issues are not created using a template.

image

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:

  • make it easier/faster to contribute
  • make it easier/faster to review issues
  • increase the overall quality of the issues that come our way

what's in this PR?

This PR:

  • deletes the PR template (this is not an "issue"; not sure why it was ever created).
  • modifies the existing templates to use the new "issue form"
  • modifies the existing templates to cut unnecessary language and streamline input

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.

ford-at-aws avatar Aug 02 '22 12:08 ford-at-aws

UPDATE: I ended up deleting the epic.yaml and task.yaml because we seldom use these templates. Instead, we'll rely on the story.yaml for internal stories and bug.yaml/enhancement.yaml for external requests.

ford-at-aws avatar Aug 03 '22 14:08 ford-at-aws