Skip to content

Commit 7a6785a

Browse files
aaoswalaaoswal
authored
chore: update issue templates per OSDS (#446)
1 parent b335e6a commit 7a6785a

File tree

10 files changed

+310
-86
lines changed

10 files changed

+310
-86
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: "\U0001F41B Bug Report"
2+
description: "Something isn't working as expected 🤔"
3+
title: "(short issue description)"
4+
labels: [bug, needs-triage]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the bug
10+
description: A clear and concise description of what the bug is.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: expected
16+
attributes:
17+
label: Expected behavior
18+
description: |
19+
Tell us what should happen.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current behavior
27+
description: |
28+
Tell us what happens instead of the expected behavior.
29+
Include full errors, uncaught exceptions, stack traces, and relevant logs.
30+
To turn on SDK logging, follow instructions here: https://github.com/awslabs/aws-sdk-kotlin/tree/main/docs/debugging.md
31+
If service responses are relevant, please include wirelogs (after removing any sensitive information!).
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: reproduction
37+
attributes:
38+
label: Steps to Reproduce
39+
description: |
40+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
41+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: context
57+
attributes:
58+
label: Context
59+
description: |
60+
How has this issue affected you? What are you trying to accomplish?
61+
Providing context helps us come up with a solution that is most useful in the real world.
62+
validations:
63+
required: false
64+
65+
- type: input
66+
id: kotlin-sdk-version
67+
attributes:
68+
label: AWS Kotlin SDK version used
69+
validations:
70+
required: true
71+
72+
- type: input
73+
id: platform-used
74+
attributes:
75+
label: Platform (JVM/JS/Native)
76+
validations:
77+
required: true
78+
79+
- type: input
80+
id: operating-system
81+
attributes:
82+
label: Operating System and version
83+
validations:
84+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.md‎

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

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: "\U0001F4D5 Documentation Issue"
2+
description: Report an issue in the API Reference documentation or Developer Guide
3+
title: "(short issue description)"
4+
labels: [documentation, needs-triage]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the issue
10+
description: A clear and concise description of the issue.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: links
16+
attributes:
17+
label: Links
18+
description: |
19+
Include links to affected documentation page(s).
20+
validations:
21+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: "\U0001F680 Feature Request"
2+
description: Suggest an idea for this project
3+
title: "(short issue description)"
4+
labels: [feature-request, needs-triage]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Community Note
10+
1. Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
11+
2. Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
12+
3. If you are interested in working on this issue, please leave a comment
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Describe the feature
18+
description: A clear and concise description of the feature you are proposing.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: Is your Feature Request related to a problem?
26+
description: |
27+
A description of the issue, e.g. "It would be great if..."
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: solution
33+
attributes:
34+
label: Proposed Solution
35+
description: |
36+
Suggest how to implement the addition or change.
37+
validations:
38+
required: false
39+
40+
- type: textarea
41+
id: alternatives
42+
attributes:
43+
label: Describe alternative solutions or features you've considered
44+
description: |
45+
Any alternative solutions or features you've considered.
46+
validations:
47+
required: false
48+
49+
- type: checkboxes
50+
id: acknowledgment
51+
attributes:
52+
label: Acknowledge
53+
options:
54+
- label: I may be able to implement this feature request
55+
required: false
56+
57+
- type: input
58+
id: kotlin-sdk-version
59+
attributes:
60+
label: AWS Kotlin SDK version used
61+
validations:
62+
required: true
63+
64+
- type: input
65+
id: platform-used
66+
attributes:
67+
label: Platform (JVM/JS/Native)
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: operating-system
73+
attributes:
74+
label: Operating System and version
75+
validations:
76+
required: true

‎.github/ISSUE_TEMPLATE/questions_help.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "\U0001F4AC Questions/Help"
2+
description: Create a new issue. If you don't know which type to choose, choose this one.
3+
title: "(short issue description)"
4+
labels: [guidance, needs-triage]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the issue
10+
description: A clear and concise description of the issue.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: reproduction
16+
attributes:
17+
label: Steps to Reproduce
18+
description: |
19+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
20+
For more complex issues provide a repo with the smallest reproducible example.
21+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: current
27+
attributes:
28+
label: Current behavior
29+
description: |
30+
Tell us what happens instead of the expected behavior.
31+
Include full errors, uncaught exceptions, stack traces, and relevant logs.
32+
To turn on SDK logging, follow instructions here: https://github.com/awslabs/aws-sdk-kotlin/tree/main/docs/debugging.md
33+
If service responses are relevant, please include wirelogs (after removing any sensitive information!).
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: kotlin-sdk-version
39+
attributes:
40+
label: AWS Kotlin SDK version used
41+
validations:
42+
required: true
43+
44+
- type: input
45+
id: platform-used
46+
attributes:
47+
label: Platform (JVM/JS/Native)
48+
validations:
49+
required: true
50+
51+
- type: input
52+
id: operating-system
53+
attributes:
54+
label: Operating System and version
55+
validations:
56+
required: true

‎.github/workflows/closed-issue-message.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Closed Issue Message
2+
on:
3+
issues:
4+
types: [closed]
5+
jobs:
6+
auto_comment:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: aws-actions/closed-issue-message@v1
10+
with:
11+
# These inputs are both required
12+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
13+
message: |
14+
### ⚠️COMMENT VISIBILITY WARNING⚠️
15+
Comments on closed issues are hard for our team to see.
16+
If you need more assistance, please either tag a team member or open a new issue that references this one.
17+
If you wish to keep having a conversation with other community members under this issue feel free to do so.

0 commit comments

Comments
 (0)