Skip to content

Conversation

ford-at-aws
Copy link
Contributor

@ford-at-aws ford-at-aws commented Aug 2, 2022

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 ford-at-aws self-assigned this Aug 2, 2022
Copy link
Contributor

@Laren-AWS Laren-AWS left a 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.

Copy link
Contributor

@Laren-AWS Laren-AWS left a 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.

@ford-at-aws ford-at-aws requested a review from Laren-AWS August 2, 2022 23:00
@beqqrry-aws beqqrry-aws self-requested a review August 2, 2022 23:16
@ford-at-aws
Copy link
Contributor Author

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.

Copy link
Contributor

@lkdavies lkdavies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editorial comments

@irenepsmith irenepsmith merged commit d1a5ce4 into main Aug 12, 2022
@DavidSouther DavidSouther deleted the new-template branch October 4, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants