Skip to content

Commit a14e190

Browse files
authored
Merge pull request #1649 from aws/kellertk/issue-templates
feat: Standardize issue templates for discussions
2 parents 715cf64 + 0c0d34a commit a14e190

File tree

5 files changed

+54
-67
lines changed

5 files changed

+54
-67
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,48 @@
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:
6-
- type: checkboxes
7-
id: terms
8-
attributes:
9-
label: Documentation
10-
description: Please confirm.
11-
options:
12-
- label: I've gone though the [API reference](https://docs.aws.amazon.com/sdk-for-go/v2/api/)
13-
required: true
14-
- label: I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-go) for answers
15-
required: true
16-
- label: I've searched for [previous similar issues](https://github.com/aws/aws-sdk-go-v2/issues) and didn't find any solution
17-
required: true
18-
198
- type: textarea
209
id: description
2110
attributes:
2211
label: Describe the bug
23-
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.
2413
validations:
2514
required: true
26-
2715
- type: textarea
2816
id: expected
2917
attributes:
30-
label: Expected behavior
18+
label: Expected Behavior
3119
description: |
32-
Tell us what should happen.
20+
What did you expect to happen?
3321
validations:
3422
required: true
35-
3623
- type: textarea
3724
id: current
3825
attributes:
39-
label: Current behavior
26+
label: Current Behavior
4027
description: |
41-
Tell us what happens instead of the expected behavior.
42-
Include full errors, uncaught exceptions, stack traces, and relevant logs.
43-
To turn on SDK logging, follow instructions here: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-logging.html
44-
If service responses are relevant, please include wirelogs.
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.
4532
validations:
46-
required: true
47-
33+
required: true
4834
- type: textarea
4935
id: reproduction
5036
attributes:
51-
label: Steps to Reproduce
37+
label: Reproduction Steps
5238
description: |
5339
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
5440
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
5542
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
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.
5644
validations:
5745
required: true
58-
5946
- type: textarea
6047
id: solution
6148
attributes:
@@ -64,6 +51,14 @@ body:
6451
Suggest a fix/reason for the bug
6552
validations:
6653
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
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.
60+
validations:
61+
required: false
6762

6863
- type: input
6964
id: Go-sdk-version

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
name: "\U0001F4DD Documentation Report"
2-
description: Suggest incorrect/improvement in documentation
1+
---
2+
name: "📕 Documentation Issue"
3+
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
810
attributes:
9-
label: Describe the issue with documentation
10-
description: A clear and concise description of what the issue is.
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
1113
validations:
1214
required: true
1315

1416
- type: textarea
15-
id: solution
17+
id: links
1618
attributes:
17-
label: Suggestion
19+
label: Links
1820
description: |
19-
Suggest a fix,improvement or addition you'd like to see in the documentation.
21+
Include links to affected documentation page(s).
2022
validations:
21-
required: false
23+
required: true
2224

2325
- type: input
2426
id: Go-sdk-version

.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: go-sdk-version

.github/ISSUE_TEMPLATE/questions-help.yml

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

0 commit comments

Comments
 (0)