Skip to content

Commit 34341ea

Browse files
KaibaLopezKaibaLopez
authored
new issue templates in yml format (#1480)
Changed the issue templates to use the '.yml' format, allowing for required fields. Almost no changes to actual content.
1 parent 468a3bc commit 34341ea

8 files changed

+179
-74
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

-31
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yml

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
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: 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+
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Describe the bug
23+
description: A clear and concise description of what the bug is.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected
29+
attributes:
30+
label: Expected behavior
31+
description: |
32+
Tell us what should happen.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: current
38+
attributes:
39+
label: Current behavior
40+
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.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: reproduction
50+
attributes:
51+
label: Steps to Reproduce
52+
description: |
53+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
54+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
55+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: solution
61+
attributes:
62+
label: Possible Solution
63+
description: |
64+
Suggest a fix/reason for the bug
65+
validations:
66+
required: false
67+
68+
- type: input
69+
id: Go-sdk-version
70+
attributes:
71+
label: AWS Go SDK version used
72+
validations:
73+
required: true
74+
75+
- type: input
76+
id: go-version
77+
attributes:
78+
label: Compiler and Version used
79+
description: output of the `go version` command
80+
validations:
81+
required: true
82+
83+
- type: input
84+
id: operating-system
85+
attributes:
86+
label: Operating System and version
87+
validations:
88+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.md

-23
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "\U0001F4DD Documentation Report"
2+
description: Suggest incorrect/improvement in documentation
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 with documentation
10+
description: A clear and concise description of what the issue is.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Suggestion
18+
description: |
19+
Suggest a fix,improvement or addition you'd like to see in the documentation.
20+
validations:
21+
required: false
22+
23+
- type: input
24+
id: Go-sdk-version
25+
attributes:
26+
label: AWS Go SDK version used
27+
validations:
28+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.md

-20
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-request.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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: go-sdk-version
51+
attributes:
52+
label: AWS Go SDK version used
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: go-version
58+
attributes:
59+
label: Go version used
60+
description: Output of `go version`
61+
validations:
62+
required: true

‎.github/ISSUE_TEMPLATE/questions-help.md ‎.github/ISSUE_TEMPLATE/questions-help.yml

File renamed without changes.

0 commit comments

Comments
 (0)