From 9dc35773ab78e630f690bcbf428cc8e44861702a Mon Sep 17 00:00:00 2001 From: Noah Litov Date: Tue, 18 Jun 2019 16:25:30 -0700 Subject: [PATCH 1/4] feat(issues): Added new, single issue template to capture issues in a more-easily triagable way --- .github/ISSUE_TEMPLATE/new_issue.md | 40 +++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/new_issue.md diff --git a/.github/ISSUE_TEMPLATE/new_issue.md b/.github/ISSUE_TEMPLATE/new_issue.md new file mode 100644 index 0000000000000..53efcc9382e5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_issue.md @@ -0,0 +1,40 @@ +--- +name: New Issue +labels: needs-triage +--- + +**Note: for support questions, please first reference our [documentation](https://docs.aws.amazon.com/CDK/latest/userguide), then use [Stackoverflow](https://stackoverflow.com/questions/ask?tags=aws-cdk)**. This repository's issues are intended for feature requests and bug reports. + +* **I'm submitting a ...** + - [ ] :beetle: bug report + - [ ] :rocket: feature request + - [ ] :books: construct library gap + - [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/awslabs/aws-cdk/securi$ + - [ ] :question: support request => Please see note at the top of this template. + + +* **What is the current behavior?** + + + +* **If the current behavior is a :beetle:bug:beetle:bug: Please provide the steps to reproduce** + + + +* **What is the expected behavior?** + + + +* **What is the motivation / use case for changing the behavior?** + + + +* **Please tell us about your environment:** + + - CDK Version: xx.xx.xx + - OS: [all | Windows 10 | OSX Mojave | Ubuntu | etc... ] + - Language: [all | TypeScript | Java | Python ] + + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc) + From 2b48896ef0cdecea45e86d7b9a04bd7c8d46d345 Mon Sep 17 00:00:00 2001 From: Noah Litov Date: Tue, 18 Jun 2019 16:51:46 -0700 Subject: [PATCH 2/4] feat(issues): Removed old issue templates to allow for new one to be non-optional --- .../new_issue.md => ISSUE_TEMPLATE.md} | 0 .github/ISSUE_TEMPLATE/bug_report.md | 22 ------------------- .github/ISSUE_TEMPLATE/feature_request.md | 10 --------- ...port-a-gap-in-the-aws-construct-library.md | 10 --------- .../request-sample-or-ask-a-question.md | 15 ------------- 5 files changed, 57 deletions(-) rename .github/{ISSUE_TEMPLATE/new_issue.md => ISSUE_TEMPLATE.md} (100%) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/report-a-gap-in-the-aws-construct-library.md delete mode 100644 .github/ISSUE_TEMPLATE/request-sample-or-ask-a-question.md diff --git a/.github/ISSUE_TEMPLATE/new_issue.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from .github/ISSUE_TEMPLATE/new_issue.md rename to .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2dd42f3245ba7..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Bug report -about: The software behaves in an unexpected way -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Command line used or code snippet - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Version:** - - OS - - Programming Language - - CDK Version diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 420c748d7867a..0000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature request -about: Suggest an idea -title: '' -labels: feature-request -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/report-a-gap-in-the-aws-construct-library.md b/.github/ISSUE_TEMPLATE/report-a-gap-in-the-aws-construct-library.md deleted file mode 100644 index 71e3cfeaaf39f..0000000000000 --- a/.github/ISSUE_TEMPLATE/report-a-gap-in-the-aws-construct-library.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Report a gap in the AWS Construct Library -about: Missing feature in the AWS Construct Library -title: '' -labels: gap -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/request-sample-or-ask-a-question.md b/.github/ISSUE_TEMPLATE/request-sample-or-ask-a-question.md deleted file mode 100644 index a0af80bd9e1be..0000000000000 --- a/.github/ISSUE_TEMPLATE/request-sample-or-ask-a-question.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Request sample or ask a question -about: Not sure how -title: '' -labels: '' -assignees: '' - ---- - -Check out the [CDK User Guide][1] or ask a question on [Stack Overflow][2] - ---thanks, The CDK Team - -[1]: https://docs.aws.amazon.com/CDK/latest/userguide -[2]: https://stackoverflow.com/questions/ask?tags=aws-cdk From 0887d4228f65607f115fd9f7a36d9091843678be Mon Sep 17 00:00:00 2001 From: Noah Litov Date: Tue, 18 Jun 2019 17:02:35 -0700 Subject: [PATCH 3/4] feat(issues): Fixed minor errors in committed issue template --- .github/ISSUE_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 53efcc9382e5e..c518002334051 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,13 +3,13 @@ name: New Issue labels: needs-triage --- -**Note: for support questions, please first reference our [documentation](https://docs.aws.amazon.com/CDK/latest/userguide), then use [Stackoverflow](https://stackoverflow.com/questions/ask?tags=aws-cdk)**. This repository's issues are intended for feature requests and bug reports. +**Note: for support questions, please first reference our [documentation](https://docs.aws.amazon.com/cdk/api/latest), then use [Stackoverflow](https://stackoverflow.com/questions/ask?tags=aws-cdk)**. This repository's issues are intended for feature requests and bug reports. * **I'm submitting a ...** - [ ] :beetle: bug report - [ ] :rocket: feature request - [ ] :books: construct library gap - - [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/awslabs/aws-cdk/securi$ + - [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/awslabs/aws-cdk/security/policy) - [ ] :question: support request => Please see note at the top of this template. @@ -17,7 +17,7 @@ labels: needs-triage -* **If the current behavior is a :beetle:bug:beetle:bug: Please provide the steps to reproduce** +* **If the current behavior is a :beetle:bug:beetle:: Please provide the steps to reproduce** From ab8db8c553573064ea172cc6d12c3139ae579a66 Mon Sep 17 00:00:00 2001 From: Noah Litov Date: Wed, 19 Jun 2019 17:48:49 -0700 Subject: [PATCH 4/4] feat(issues): Revised based on team suggestions. --- .github/ISSUE_TEMPLATE.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c518002334051..f9be6c5871dfa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -14,24 +14,22 @@ labels: needs-triage * **What is the current behavior?** +*If the current behavior is a :beetle:bug:beetle:: Please provide the steps to reproduce* -* **If the current behavior is a :beetle:bug:beetle:: Please provide the steps to reproduce** +* **What is the expected behavior (or behavior of feature suggested)?** -* **What is the expected behavior?** - - - -* **What is the motivation / use case for changing the behavior?** +* **What is the motivation / use case for changing the behavior or adding this feature?** * **Please tell us about your environment:** - - CDK Version: xx.xx.xx + - CDK CLI Version: xx.xx.xx + - Module Version: xx.xx.xx - OS: [all | Windows 10 | OSX Mojave | Ubuntu | etc... ] - Language: [all | TypeScript | Java | Python ]