From 2a8a6c995c135f47f6ecb91bdd7873ea8e46209b Mon Sep 17 00:00:00 2001 From: Joseph Klix Date: Wed, 6 Apr 2022 10:16:34 -0700 Subject: [PATCH] feat: Standardize issue templates for discussions (#254) Co-authored-by: kellertk --- .github/ISSUE_TEMPLATE/---feature-request.yml | 47 ------ .../ISSUE_TEMPLATE/---questions---help.yml | 57 ------- .../{---bug-report.yml => bug-report.yml} | 146 +++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/documentation.yml | 23 +++ .github/ISSUE_TEMPLATE/feature-request.yml | 59 +++++++ 6 files changed, 160 insertions(+), 177 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/---questions---help.yml rename .github/ISSUE_TEMPLATE/{---bug-report.yml => bug-report.yml} (50%) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/---feature-request.yml b/.github/ISSUE_TEMPLATE/---feature-request.yml deleted file mode 100644 index 9abe6ddd5..000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.yml +++ /dev/null @@ -1,47 +0,0 @@ -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 diff --git a/.github/ISSUE_TEMPLATE/---questions---help.yml b/.github/ISSUE_TEMPLATE/---questions---help.yml deleted file mode 100644 index c0c2f4626..000000000 --- a/.github/ISSUE_TEMPLATE/---questions---help.yml +++ /dev/null @@ -1,57 +0,0 @@ -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: false - - - 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. - validations: - required: false - - - type: input - id: aws-iot-device-sdk-java-v2 - attributes: - label: aws-iot-device-sdk-java-v2 version used - validations: - required: true - - - type: input - id: compiler-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 diff --git a/.github/ISSUE_TEMPLATE/---bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml similarity index 50% rename from .github/ISSUE_TEMPLATE/---bug-report.yml rename to .github/ISSUE_TEMPLATE/bug-report.yml index d0b9c926d..94d19fbfd 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,73 +1,73 @@ -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. - 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: aws-iot-device-sdk-java-v2 - attributes: - label: aws-iot-device-sdk-java-v2 version used - validations: - required: true - - - type: input - id: compiler-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 +--- +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 index 3ba13e0ce..94e5cddac 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,6 @@ +--- blank_issues_enabled: false +contact_links: + - name: 💬 General Question + url: https://github.com/aws/aws-iot-device-sdk-java-v2/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 000000000..7d73869ae --- /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 000000000..60d2431af --- /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