From 77a9d7f0d6f4ef2de5ef3faae086d9cdeb136dd2 Mon Sep 17 00:00:00 2001 From: debora-ito Date: Fri, 15 Oct 2021 12:04:32 -0700 Subject: [PATCH 1/2] Upgrade to Github issue form templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 87 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/documentation.yml | 21 ++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 69 +++++++++++++++++ .github/ISSUE_TEMPLATE/general-issue.yml | 59 +++++++++++++++ 5 files changed, 237 insertions(+) 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 create mode 100644 .github/ISSUE_TEMPLATE/general-issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000000..bebd42b85bc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,87 @@ +name: "\U0001F41B Bug Report" +description: File a bug report +title: "(short issue description)" +labels: [bug, needs-triage] +body: + - 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: textarea + id: context + attributes: + label: Context + description: | + How has this issue affected you? What are you trying to accomplish? + Providing context helps us come up with a solution that is most useful in the real world. + validations: + required: false + + - type: input + id: java-sdk-version + attributes: + label: AWS Java SDK version used + validations: + required: true + + - type: input + id: jdk-version + attributes: + label: JDK version used + description: Output of `java -version` + 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 000000000000..ec4bb386bcf8 --- /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.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000000..e07211a7f344 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,21 @@ +name: "\U0001F4D5 Documentation Issue" +description: Report an issue in the API Reference documentation or Developer Guide +title: "(short issue description)" +labels: [documentation, needs-triage] +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 \ 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 000000000000..edb5b9d5852a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,69 @@ +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: java-sdk-version + attributes: + label: AWS Java SDK version used + validations: + required: true + + - type: input + id: jdk-version + attributes: + label: JDK version used + description: Output of `java -version` + 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/general-issue.yml b/.github/ISSUE_TEMPLATE/general-issue.yml new file mode 100644 index 000000000000..bf3b00a23b52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-issue.yml @@ -0,0 +1,59 @@ +name: "\U0001F4AC General Issue" +description: Create a new issue. If you don't know which type to choose, choose this one. +title: "(short issue description)" +labels: [guidance, needs-triage] +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: 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 reproducible example. + + Avoid including business logic or unrelated code, it makes diagnosis more difficult. + 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: input + id: java-sdk-version + attributes: + label: AWS Java SDK version used + validations: + required: true + + - type: input + id: jdk-version + attributes: + label: JDK version used + description: Output of `java -version` + validations: + required: true + + - type: input + id: operating-system + attributes: + label: Operating System and version + validations: + required: true From 00adb05ea3e7fe9ad959f7e9b9cef0e04ba8f8f2 Mon Sep 17 00:00:00 2001 From: debora-ito Date: Fri, 15 Oct 2021 12:04:32 -0700 Subject: [PATCH 2/2] Upgrade to Github issue form templates --- .github/ISSUE_TEMPLATE.md | 31 ------------------ .github/ISSUE_TEMPLATE/bug-report.md | 38 ----------------------- .github/ISSUE_TEMPLATE/documentation.md | 15 --------- .github/ISSUE_TEMPLATE/feature-request.md | 36 --------------------- .github/ISSUE_TEMPLATE/general-issue.md | 28 ----------------- .github/workflows/stale-issue.yml | 2 +- 6 files changed, 1 insertion(+), 149 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/general-issue.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index ace5fc906e0f..000000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,31 +0,0 @@ - - -## Expected Behavior - - - -## Current Behavior - - - - - - -## Possible Solution - - - -## Steps to Reproduce (for bugs) - - - - -## Context - - - -## Your Environment - -* AWS Java SDK version used: -* JDK version used: -* Operating System and version: diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index b3680fa48f95..000000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve -labels: bug, needs-triage ---- - - - -## Describe the bug - - -## Expected Behavior - - -## Current Behavior - - - - - - -## Steps to Reproduce - - - - -## Possible Solution - - -## Context - - - -## Your Environment - -* AWS Java SDK version used: -* JDK version used: -* Operating System and version: diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index fac624d37159..000000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: "\U0001F4D5 Documentation Issue" -about: Report an issue in the API Reference documentation or Developer Guide -labels: documentation, needs-triage ---- - - - -## Describe the issue - - -## Links - - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 9492a02c8a94..000000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: "\U0001F680 Feature Request" -about: Suggest an idea for this project -labels: feature-request, needs-triage ---- - - - -## Describe the Feature - - -## Is your Feature Request related to a problem? - - -## Proposed Solution - - -## Describe alternatives you've considered - - -## Additional Context - - - - - - - -- [ ] I may be able to implement this feature request - - -## Your Environment - -* AWS Java SDK version used: -* JDK version used: -* Operating System and version: diff --git a/.github/ISSUE_TEMPLATE/general-issue.md b/.github/ISSUE_TEMPLATE/general-issue.md deleted file mode 100644 index 52273edcc004..000000000000 --- a/.github/ISSUE_TEMPLATE/general-issue.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "\U0001F4AC General Issue" -about: Create a new issue -labels: guidance, needs-triage ---- - - - -## Describe the issue - - -## Steps to Reproduce - - - - -## Current Behavior - - - - - - -## Your Environment - -* AWS Java SDK version used: -* JDK version used: -* Operating System and version: diff --git a/.github/workflows/stale-issue.yml b/.github/workflows/stale-issue.yml index ec9e332cb063..b1dc949d21dd 100644 --- a/.github/workflows/stale-issue.yml +++ b/.github/workflows/stale-issue.yml @@ -29,7 +29,7 @@ jobs: # These labels are required stale-issue-label: closing-soon - exempt-issue-labels: no-auto-closure, feature-request, bug + exempt-issue-labels: no-auto-closure stale-pr-label: closing-soon exempt-pr-labels: no-auto-closure response-requested-label: response-requested