Skip to content

Commit 0e53459

Browse files
kellertkdebora-ito
andauthored
feat: Standardize issue templates for discussions (#3141)
* feat: Standardize issue templates for discussions * fix: add back in logging statement Co-authored-by: Debora N. Ito <[email protected]>
1 parent 6706177 commit 0e53459

File tree

5 files changed

+43
-98
lines changed

5 files changed

+43
-98
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,49 @@
1-
name: "\U0001F41B Bug Report"
2-
description: File a bug report
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
34
title: "(short issue description)"
45
labels: [bug, needs-triage]
6+
assignees: []
57
body:
68
- type: textarea
79
id: description
810
attributes:
911
label: Describe the bug
10-
description: A clear and concise description of what the bug is.
12+
description: What is the problem? A clear and concise description of the bug.
1113
validations:
1214
required: true
13-
1415
- type: textarea
1516
id: expected
1617
attributes:
17-
label: Expected behavior
18+
label: Expected Behavior
1819
description: |
19-
Tell us what should happen.
20+
What did you expect to happen?
2021
validations:
2122
required: true
22-
2323
- type: textarea
2424
id: current
2525
attributes:
26-
label: Current behavior
26+
label: Current Behavior
2727
description: |
28-
Tell us what happens instead of the expected behavior.
29-
30-
Include full errors, uncaught exceptions, stack traces, and relevant logs.
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
3132
To turn on SDK logging, follow instructions here: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-logging.html
32-
If service responses are relevant, please include wirelogs.
3333
validations:
34-
required: true
35-
34+
required: true
3635
- type: textarea
3736
id: reproduction
3837
attributes:
39-
label: Steps to Reproduce
38+
label: Reproduction Steps
4039
description: |
4140
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
4241
For more complex issues provide a repo with the smallest sample that reproduces the bug.
43-
42+
4443
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
44+
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.
4545
validations:
4646
required: true
47-
4847
- type: textarea
4948
id: solution
5049
attributes:
@@ -53,14 +52,12 @@ body:
5352
Suggest a fix/reason for the bug
5453
validations:
5554
required: false
56-
5755
- type: textarea
5856
id: context
5957
attributes:
60-
label: Context
58+
label: Additional Information/Context
6159
description: |
62-
How has this issue affected you? What are you trying to accomplish?
63-
Providing context helps us come up with a solution that is most useful in the real world.
60+
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.
6461
validations:
6562
required: false
6663

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
blank_issues_enabled: false
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 General Question
5+
url: https://github.com/aws/aws-sdk-java-v2/discussions/categories/q-a
6+
about: Please ask and answer questions as a discussion thread

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
name: "\U0001F4D5 Documentation Issue"
1+
---
2+
name: "📕 Documentation Issue"
23
description: Report an issue in the API Reference documentation or Developer Guide
34
title: "(short issue description)"
45
labels: [documentation, needs-triage]
6+
assignees: []
57
body:
68
- type: textarea
79
id: description
@@ -18,4 +20,4 @@ body:
1820
description: |
1921
Include links to affected documentation page(s).
2022
validations:
21-
required: true
23+
required: true

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
name: "\U0001F680 Feature Request"
1+
---
2+
name: 🚀 Feature Request
23
description: Suggest an idea for this project
34
title: "(short issue description)"
45
labels: [feature-request, needs-triage]
6+
assignees: []
57
body:
68
- type: textarea
79
id: description
@@ -10,41 +12,39 @@ body:
1012
description: A clear and concise description of the feature you are proposing.
1113
validations:
1214
required: true
13-
1415
- type: textarea
15-
id: problem
16+
id: use-case
1617
attributes:
17-
label: Is your Feature Request related to a problem?
18+
label: Use Case
1819
description: |
19-
A description of the issue, e.g. "I'm always frustrated when..."
20+
Why do you need this feature? For example: "I'm always frustrated when..."
2021
validations:
21-
required: true
22-
22+
required: true
2323
- type: textarea
2424
id: solution
2525
attributes:
2626
label: Proposed Solution
2727
description: |
28-
Suggest how to implement the addition or change.
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
2929
validations:
3030
required: false
31-
3231
- type: textarea
33-
id: alternatives
32+
id: other
3433
attributes:
35-
label: Describe alternatives you've considered
34+
label: Other Information
3635
description: |
37-
Any alternative solutions or features you've considered.
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
3837
validations:
3938
required: false
40-
4139
- type: checkboxes
42-
id: acknowledgment
40+
id: ack
4341
attributes:
44-
label: Acknowledge
42+
label: Acknowledgements
4543
options:
4644
- label: I may be able to implement this feature request
4745
required: false
46+
- label: This feature might incur a breaking change
47+
required: false
4848

4949
- type: input
5050
id: java-sdk-version

.github/ISSUE_TEMPLATE/general-issue.yml

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)