From b10aefa2dd7d00dce4ccbd003c57cb9010e4beff Mon Sep 17 00:00:00 2001 From: Mathieu Grandis <73313235+mgrandis@users.noreply.github.com> Date: Tue, 2 Feb 2021 15:17:09 -0800 Subject: [PATCH 1/3] chore: Add issue and feature request GitHub templates Based on the SAM CLI repo templates --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..f701da9711 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create an issue to report a bug for the SAM Translator +title: '' +labels: '' +assignees: '' + +--- + + + +### Description: + + + + +### Steps to reproduce: + + + + +### Observed result: + + + + +### Expected result: + + + + +### Additional environment details (Ex: Windows, Mac, Amazon Linux etc) + +1. OS: +2. `sam --version`: +3. AWS region: + +`Add --debug flag to commands you are running` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..0de7765681 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea/feature/enhancement for the SAM Translator +title: '' +labels: '' +assignees: '' + +--- + + + +### Describe your idea/feature/enhancement + +Provide a clear description. Ex. I wish the SAM Translator would [...] + +### Proposal + +Add details of how to add this to the product. + +Things to consider: +1. Will this require any updates to the [SAM Spec](https://github.com/awslabs/serverless-application-model) + +### Additional Details From e565651b8a229258a7e68eaee03ef02dc6da25e6 Mon Sep 17 00:00:00 2001 From: Mathieu Grandis Date: Wed, 3 Feb 2021 16:50:07 -0800 Subject: [PATCH 2/3] chore: Updates --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 8 +++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f701da9711..27d29d044b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -33,7 +33,7 @@ If you do find an existing Issue, re-open or add a comment to that Issue instead ### Additional environment details (Ex: Windows, Mac, Amazon Linux etc) 1. OS: -2. `sam --version`: +2. If using SAM CLI, `sam --version`: 3. AWS region: -`Add --debug flag to commands you are running` +`Add --debug flag to any SAM CLI commands you are running` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0de7765681..391aa06497 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,17 +7,19 @@ assignees: '' --- - + ### Describe your idea/feature/enhancement -Provide a clear description. Ex. I wish the SAM Translator would [...] +Provide a clear description. + +Ex: I wish the SAM Translator would [...] ### Proposal Add details of how to add this to the product. Things to consider: -1. Will this require any updates to the [SAM Spec](https://github.com/awslabs/serverless-application-model) +[ ] The [SAM documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html) will need to be updated ### Additional Details From 1bc55c7c797be0695cbe89b8d23e3a9a1215e7a6 Mon Sep 17 00:00:00 2001 From: Mathieu Grandis Date: Wed, 3 Feb 2021 18:26:37 -0800 Subject: [PATCH 3/3] fix: Typo --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 391aa06497..144feb3fb7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -17,7 +17,7 @@ Ex: I wish the SAM Translator would [...] ### Proposal -Add details of how to add this to the product. +Add details on how to add this to the product. Things to consider: [ ] The [SAM documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html) will need to be updated