Skip to content
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

chore: add yaml issue template #1338

Merged
merged 7 commits into from
Jun 1, 2021
Merged

chore: add yaml issue template #1338

merged 7 commits into from
Jun 1, 2021

Conversation

div5yesh
Copy link
Contributor

create new yaml issue template to get detailed info on bugs.

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@div5yesh div5yesh marked this pull request as ready for review May 26, 2021 18:55
@div5yesh div5yesh requested a review from a team May 26, 2021 18:55
Copy link
Contributor

@richardmcclellan richardmcclellan left a comment

Choose a reason for hiding this comment

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

Overall, I really like the "form" style that you are introducing here! Especially inserting the codeblock automatically that customers can just paste their code in will be nice, because customers often fail to do that on their own. This should certainly reduce the friction for customers a little bit.

The goal of the template should be to minimize the number of follow up questions that we need to ask the customer, but we also don't want to collect info that isn't usually relevant, since it will increase the length of the issue, and thus the time that it takes to triage issues during sprint planning or during on call. I suggested a couple ways to simplify / reduce the number of questions asked.

.github/ISSUE_TEMPLATE/1.bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1.bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1.bug_report.yaml Outdated Show resolved Hide resolved
div5yesh and others added 2 commits May 26, 2021 13:11
remove redundant questions

Co-authored-by: Richard McClellan <[email protected]>
@richardmcclellan
Copy link
Contributor

These two questions are asked on our existing bug template, and do sometimes result in useful context, so we should add them to this one:

  • Any relevant guides or documentation you're referencing
  • For CLI issues, include any relevant logs in ~/.amplify/logs/amplify-cli-.log

Also, as a part of this PR, please remove the old bug template, since we only need one.

Copy link
Contributor

@richardmcclellan richardmcclellan left a comment

Choose a reason for hiding this comment

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

🚀

@div5yesh div5yesh merged commit 31fafad into aws-amplify:main Jun 1, 2021
@div5yesh div5yesh deleted the chore/yaml-issue-template branch June 1, 2021 20:22
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.

2 participants