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

feat(issues): new format for issue templates #2917

Merged
merged 4 commits into from
Jun 20, 2019

Conversation

NGL321
Copy link
Contributor

@NGL321 NGL321 commented Jun 19, 2019

Merged the issue templates into a single template in order to simplify triage, reduce miscategorization and duplicates, and reduce work to submit while still requiring sufficient information.

Provides opportunities to add reproduction-steps for bugs, desired behavior for feature-requests, and guides support questions to Stack Overflow without disallowing the cross-post here.

Looking for feedback.


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

@NGL321 NGL321 added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 19, 2019
@NGL321 NGL321 requested a review from a team as a code owner June 19, 2019 00:14
@NGL321 NGL321 changed the title feat(issues): New format for issue templates feat(issues): new format for issue templates Jun 19, 2019
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

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

Looks great


* **Please tell us about your environment:**

- CDK Version: xx.xx.xx
Copy link
Contributor

Choose a reason for hiding this comment

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

Worth separating CDK CLI (“cdk --version”) version and modules version

@NGL321 NGL321 merged commit 67f6de0 into aws:master Jun 20, 2019
@eladb
Copy link
Contributor

eladb commented Jun 20, 2019

@NGL321 make sure that the new template will automatically add the needs-triage tag to new issues. There's a way to do that, not sure exactly how...

@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants