From 34341ea34cd55b78800ed91cce531ed58f1ae09c Mon Sep 17 00:00:00 2001 From: Gilberto Lopez Zayas Date: Tue, 9 Nov 2021 15:15:03 -0700 Subject: [PATCH] new issue templates in yml format (#1480) Changed the issue templates to use the '.yml' format, allowing for required fields. Almost no changes to actual content. --- .github/ISSUE_TEMPLATE/bug-report.md | 31 ------- .github/ISSUE_TEMPLATE/bug-report.yml | 88 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/documentation.md | 23 ----- .github/ISSUE_TEMPLATE/documentation.yml | 28 ++++++ .github/ISSUE_TEMPLATE/feature-request.md | 20 ----- .github/ISSUE_TEMPLATE/feature-request.yml | 62 +++++++++++++ .../{questions-help.md => questions-help.yml} | 0 8 files changed, 179 insertions(+), 74 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml rename .github/ISSUE_TEMPLATE/{questions-help.md => questions-help.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 234139b8204..00000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,31 +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 though the [API reference](https://docs.aws.amazon.com/sdk-for-go/v2/api/) -- [ ] I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-go) for answers -- [ ] I've searched for [previous similar issues](https://github.com/aws/aws-sdk-go-v2/issues) and didn't find any solution - -**Describe the bug** -A clear and concise description of what the bug is. - -**Version of AWS SDK for Go?** -Example: v1.29.22 -* get SDK version by printing the output of `aws.SDKVersion` in your code after importing `"github.com/aws/aws-sdk-go-v2/aws"` - -**Version of Go (`go version`)?** - -**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. - -**Additional context** -Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000000..b8494a4e652 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,88 @@ +name: "\U0001F41B Bug Report" +description: File a bug report +title: "(short issue description)" +labels: [bug, needs-triage] +body: + - type: checkboxes + id: terms + attributes: + label: Documentation + description: Please confirm. + options: + - label: I've gone though the [API reference](https://docs.aws.amazon.com/sdk-for-go/v2/api/) + required: true + - label: I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-go) for answers + required: true + - label: I've searched for [previous similar issues](https://github.com/aws/aws-sdk-go-v2/issues) and didn't find any solution + required: true + + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + Tell us what should happen. + validations: + required: true + + - type: textarea + id: current + attributes: + label: Current behavior + description: | + Tell us what happens instead of the expected behavior. + Include full errors, uncaught exceptions, stack traces, and relevant logs. + To turn on SDK logging, follow instructions here: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-logging.html + If service responses are relevant, please include wirelogs. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + 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. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Possible Solution + description: | + Suggest a fix/reason for the bug + validations: + required: false + + - type: input + id: Go-sdk-version + attributes: + label: AWS Go SDK version used + validations: + required: true + + - type: input + id: go-version + attributes: + label: Compiler and Version used + description: output of the `go version` command + validations: + required: true + + - type: input + id: operating-system + attributes: + label: Operating System and version + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..ec4bb386bcf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 645d5a9c070..00000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: "\U0001F4DDDocumentation" -about: Suggest incorrect/improvement in documentation -title: '' -labels: documentation, needs-triage -assignees: '' - ---- - -**Describe the issue with documentation** -A clear and concise description of what the issue is. - -**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. \ 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 00000000000..c7c41d8eb2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,28 @@ +name: "\U0001F4DD Documentation Report" +description: Suggest incorrect/improvement in documentation +title: "(short issue description)" +labels: [documentation, needs-triage] +body: + - type: textarea + id: description + attributes: + label: Describe the issue with documentation + description: A clear and concise description of what the issue is. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Suggestion + description: | + Suggest a fix,improvement or addition you'd like to see in the documentation. + validations: + required: false + + - type: input + id: Go-sdk-version + attributes: + label: AWS Go SDK version used + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 8b6a0e1f35b..00000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Suggest an idea for this project -title: '' -labels: feature-request, needs-triage -assignees: '' - ---- - -**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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000000..9f422829e06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,62 @@ +name: "\U0001F680 Feature Request" +description: Suggest an idea for this project +title: "(short issue description)" +labels: [feature-request, needs-triage] +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: problem + attributes: + label: Is your Feature Request related to a problem? + description: | + A description of the issue, e.g. "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. + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: | + Any alternative solutions or features you've considered. + validations: + required: false + + - type: checkboxes + id: acknowledgment + attributes: + label: Acknowledge + options: + - label: I may be able to implement this feature request + required: false + + - type: input + id: go-sdk-version + attributes: + label: AWS Go SDK version used + validations: + required: true + + - type: input + id: go-version + attributes: + label: Go version used + description: Output of `go version` + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/questions-help.md b/.github/ISSUE_TEMPLATE/questions-help.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/questions-help.md rename to .github/ISSUE_TEMPLATE/questions-help.yml