Skip to content

feat: Standardize issue templates for discussions #3141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,49 @@
name: "\U0001F41B Bug Report"
description: File a bug report
---
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: A clear and concise description of what the bug is.
description: What is the problem? A clear and concise description of the bug.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
label: Expected Behavior
description: |
Tell us what should happen.
What did you expect to happen?
validations:
required: true

- type: textarea
id: current
attributes:
label: Current behavior
label: Current Behavior
description: |
Tell us what happens instead of the expected behavior.

Include full errors, uncaught exceptions, stack traces, and relevant logs.
What actually happened?

Please include full errors, uncaught exceptions, stack traces, and relevant logs.
If service responses are relevant, please include wire 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

required: true
- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
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:
Expand All @@ -53,14 +52,12 @@ body:
Suggest a fix/reason for the bug
validations:
required: false

- type: textarea
id: context
attributes:
label: Context
label: Additional Information/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.
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

Expand Down
7 changes: 6 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
blank_issues_enabled: false
---
blank_issues_enabled: false
contact_links:
- name: 💬 General Question
url: https://github.com/aws/aws-sdk-java-v2/discussions/categories/q-a
about: Please ask and answer questions as a discussion thread
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
name: "\U0001F4D5 Documentation Issue"
---
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
Expand All @@ -18,4 +20,4 @@ body:
description: |
Include links to affected documentation page(s).
validations:
required: true
required: true
30 changes: 15 additions & 15 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
name: "\U0001F680 Feature Request"
---
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
Expand All @@ -10,41 +12,39 @@ body:
description: A clear and concise description of the feature you are proposing.
validations:
required: true

- type: textarea
id: problem
id: use-case
attributes:
label: Is your Feature Request related to a problem?
label: Use Case
description: |
A description of the issue, e.g. "I'm always frustrated when..."
Why do you need this feature? For example: "I'm always frustrated when..."
validations:
required: true

required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Suggest how to implement the addition or change.
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
validations:
required: false

- type: textarea
id: alternatives
id: other
attributes:
label: Describe alternatives you've considered
label: Other Information
description: |
Any alternative solutions or features you've considered.
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: acknowledgment
id: ack
attributes:
label: Acknowledge
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: java-sdk-version
Expand Down
59 changes: 0 additions & 59 deletions .github/ISSUE_TEMPLATE/general-issue.yml

This file was deleted.