-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Standardize issue templates for discussions (#254)
Co-authored-by: kellertk <[email protected]>
- Loading branch information
Showing
6 changed files
with
160 additions
and
177 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
146 changes: 73 additions & 73 deletions
146
.github/ISSUE_TEMPLATE/---bug-report.yml → .github/ISSUE_TEMPLATE/bug-report.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |