Skip to content

Commit 0b2a409

Browse files
debora-itodebora-ito
authored
Upgrade to GitHub issue form templates (#2772)
* Upgrade to Github issue form templates
1 parent e5570f7 commit 0b2a409

File tree

11 files changed

+238
-149
lines changed

11 files changed

+238
-149
lines changed

‎.github/ISSUE_TEMPLATE.md

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

‎.github/ISSUE_TEMPLATE/bug-report.md

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

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: "\U0001F41B Bug Report"
2+
description: File a bug report
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+
30+
Include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
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.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: reproduction
38+
attributes:
39+
label: Steps to Reproduce
40+
description: |
41+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
42+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
43+
44+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: solution
50+
attributes:
51+
label: Possible Solution
52+
description: |
53+
Suggest a fix/reason for the bug
54+
validations:
55+
required: false
56+
57+
- type: textarea
58+
id: context
59+
attributes:
60+
label: Context
61+
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.
64+
validations:
65+
required: false
66+
67+
- type: input
68+
id: java-sdk-version
69+
attributes:
70+
label: AWS Java SDK version used
71+
validations:
72+
required: true
73+
74+
- type: input
75+
id: jdk-version
76+
attributes:
77+
label: JDK version used
78+
description: Output of `java -version`
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: operating-system
84+
attributes:
85+
label: Operating System and version
86+
validations:
87+
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 & 15 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 & 36 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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: textarea
7+
id: description
8+
attributes:
9+
label: Describe the feature
10+
description: A clear and concise description of the feature you are proposing.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: Is your Feature Request related to a problem?
18+
description: |
19+
A description of the issue, e.g. "I'm always frustrated when..."
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change.
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Describe alternatives you've considered
36+
description: |
37+
Any alternative solutions or features you've considered.
38+
validations:
39+
required: false
40+
41+
- type: checkboxes
42+
id: acknowledgment
43+
attributes:
44+
label: Acknowledge
45+
options:
46+
- label: I may be able to implement this feature request
47+
required: false
48+
49+
- type: input
50+
id: java-sdk-version
51+
attributes:
52+
label: AWS Java SDK version used
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: jdk-version
58+
attributes:
59+
label: JDK version used
60+
description: Output of `java -version`
61+
validations:
62+
required: true
63+
64+
- type: input
65+
id: operating-system
66+
attributes:
67+
label: Operating System and version
68+
validations:
69+
required: true

‎.github/ISSUE_TEMPLATE/general-issue.md

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

‎.github/ISSUE_TEMPLATE/general-issue.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "\U0001F4AC General Issue"
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+
22+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: current
28+
attributes:
29+
label: Current behavior
30+
description: |
31+
Tell us what happens instead of the expected behavior.
32+
33+
Include full errors, uncaught exceptions, stack traces, and relevant logs.
34+
To turn on SDK logging, follow instructions here: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-logging.html
35+
If service responses are relevant, please include wirelogs.
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: java-sdk-version
41+
attributes:
42+
label: AWS Java SDK version used
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: jdk-version
48+
attributes:
49+
label: JDK version used
50+
description: Output of `java -version`
51+
validations:
52+
required: true
53+
54+
- type: input
55+
id: operating-system
56+
attributes:
57+
label: Operating System and version
58+
validations:
59+
required: true

0 commit comments

Comments
 (0)