From 51a04a13591394d9e1de83a469410398c86d0797 Mon Sep 17 00:00:00 2001 From: Tom Keller <1083460+kellertk@users.noreply.github.com> Date: Mon, 23 May 2022 06:22:50 -0700 Subject: [PATCH] feat: Standardize issue templates for discussions (#4063) --- .github/ISSUE_TEMPLATE/---bug-report.md | 45 ------------ .github/ISSUE_TEMPLATE/---feature-request.md | 22 ------ .github/ISSUE_TEMPLATE/---known-issues.md | 23 ------ .github/ISSUE_TEMPLATE/---questions---help.md | 15 ---- .github/ISSUE_TEMPLATE/bug-report.yml | 73 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 ++ .github/ISSUE_TEMPLATE/documentation.yml | 23 ++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 59 +++++++++++++++ 8 files changed, 161 insertions(+), 105 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/---known-issues.md delete mode 100644 .github/ISSUE_TEMPLATE/---questions---help.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md deleted file mode 100644 index 310e37a81e..0000000000 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve -title: '' -labels: bug, needs-triage -assignees: '' - ---- - -Confirm by changing [ ] to [x] below to ensure that it's a bug: -- [ ] I've gone through [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/) -- [ ] I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) for answers -- [ ] I've searched for [previous similar issues](https://github.com/aws/aws-sdk-js/issues) and didn't find any solution -- [ ] This is an issue with version 2.x of the SDK - -**Describe the bug** -A clear and concise description of what the bug is. - -**Is the issue in the browser/Node.js?** -Browser/Node.js - -**If on Node.js, are you running this on AWS Lambda?** - -**Details of the browser/Node.js version** -Paste output of `npx envinfo --browsers` or `node -v` - -**SDK version number** -Example: v2.466.0 -* For browsers, the SDK version number is in the script tag 
src=".../aws-sdk-2.466.0.min.js"
-* For Node.js, get SDK version by - * running command `npm list aws-sdk` from your root directory - * printing the output of `console.log(AWS.VERSION)` in your code where `AWS = require("aws-sdk");` - * if running on Lambda and using SDK provided by Lambda runtime, you can find the SDK versions [here](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) - -**To Reproduce (observed behavior)** -Steps to reproduce the behavior (please share code or minimal repo) - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md deleted file mode 100644 index fd5590ce27..0000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Suggest an idea for this project -title: '' -labels: feature-request -assignees: '' - ---- -Confirm by changing [ ] to [x] below: -- [ ] This is a feature with version 2.x of the SDK - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/---known-issues.md b/.github/ISSUE_TEMPLATE/---known-issues.md deleted file mode 100644 index ea8b4383fe..0000000000 --- a/.github/ISSUE_TEMPLATE/---known-issues.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: "\U0001F6E0 'Unexpected key' or 'is not a function' error" -about: API call returns 'Unexpected key' or 'is not a function' error -title: '' -assignees: '' - ---- - - - - AWS APIs are updating constantly, you might be calling a new API with an older version is SDK. In - this case you should try installing the newest `aws-sdk` like: - - `npm install aws-sdk@latest` - - If you are using the SDK in AWS Lambda, you are likely using old SDK version too. AWS Lambda bundled - SDK version is shown in [this document](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). - You can import the latest version of SDK by following - [these guidelines](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html#nodejs-package-dependencies). - -If you still like to open an issue, change [ ] to [x] below: -- [ ] I've confirmed that I'm using latest version of SDK, and issue is still reproducible -- [ ] This is an issue with version 2.x of the SDK diff --git a/.github/ISSUE_TEMPLATE/---questions---help.md b/.github/ISSUE_TEMPLATE/---questions---help.md deleted file mode 100644 index 46f06b3edd..0000000000 --- a/.github/ISSUE_TEMPLATE/---questions---help.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: "\U0001F4AC Questions / Help" -about: If you have questions, please check AWS Forums or StackOverflow -title: '' -labels: guidance, needs-triage -assignees: '' - ---- - -Confirm by changing [ ] to [x] below: -- [ ] I've gone through [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/) -- [ ] I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) for answers -- [ ] This is an issue with version 2.x of the SDK - -**Describe the question** diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..94d19fbfdd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,73 @@ +--- +name: "🐛 Bug Report" +description: Report a bug +title: "(short issue description)" +labels: [bug, needs-triage] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: What is the problem? A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: | + What did you expect to happen? + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: | + What actually happened? + + Please include full errors, uncaught exceptions, stack traces, and relevant logs. + If service responses are relevant, please include wire logs. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + Provide a self-contained, concise snippet of code that can be used to reproduce the issue. + For more complex issues provide a repo with the smallest sample that reproduces the bug. + + Avoid including business logic or unrelated code, it makes diagnosis more difficult. + The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Possible Solution + description: | + Suggest a fix/reason for the bug + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Information/Context + description: | + Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world. + validations: + required: false + - type: input + id: sdk-version + attributes: + label: SDK version used + validations: + required: true + - type: input + id: environment + attributes: + label: Environment details (OS name and version, etc.) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..68c4067b6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +--- +blank_issues_enabled: false +contact_links: + - name: 💬 General Question + url: https://github.com/aws/aws-sdk-js/discussions/categories/q-a + about: Please ask and answer questions as a discussion thread \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000000..7d73869aea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,23 @@ +--- +name: "📕 Documentation Issue" +description: Report an issue in the API Reference documentation or Developer Guide +title: "(short issue description)" +labels: [documentation, needs-triage] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Describe the issue + description: A clear and concise description of the issue. + validations: + required: true + + - type: textarea + id: links + attributes: + label: Links + description: | + Include links to affected documentation page(s). + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..60d2431af2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,59 @@ +--- +name: 🚀 Feature Request +description: Suggest an idea for this project +title: "(short issue description)" +labels: [feature-request, needs-triage] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Describe the feature + description: A clear and concise description of the feature you are proposing. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Use Case + description: | + Why do you need this feature? For example: "I'm always frustrated when..." + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: | + Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation. + validations: + required: false + - type: textarea + id: other + attributes: + label: Other Information + description: | + Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc. + validations: + required: false + - type: checkboxes + id: ack + attributes: + label: Acknowledgements + options: + - label: I may be able to implement this feature request + required: false + - label: This feature might incur a breaking change + required: false + - type: input + id: sdk-version + attributes: + label: SDK version used + validations: + required: true + - type: input + id: environment + attributes: + label: Environment details (OS name and version, etc.) + validations: + required: true