Skip to content

Commit b76839d

Browse files
authored
fix(docs): re-add customizations in bug report template (#3844)
1 parent 6fb9d1d commit b76839d

File tree

1 file changed

+52
-26
lines changed

1 file changed

+52
-26
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,71 @@
11
---
22
name: "🐛 Bug Report"
33
description: Report a bug
4-
title: "(short issue description)"
4+
title: "TITLE FOR BUG REPORT"
55
labels: [bug, needs-triage]
66
assignees: []
77
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Checkboxes for prior research
11+
options:
12+
- label: I've gone through [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide)
13+
and [API reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest)
14+
required: true
15+
- label: I've checked [AWS Forums](https://forums.aws.amazon.com) and
16+
[StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js).
17+
required: true
18+
- label: I've searched for [previous similar issues](https://github.com/aws/aws-sdk-js-v3/issues)
19+
and didn't find any solution.
20+
required: true
821
- type: textarea
922
id: description
1023
attributes:
1124
label: Describe the bug
12-
description: What is the problem? A clear and concise description of the bug.
25+
description: What is the problem?
26+
placeholder: A clear and concise description of the bug.
27+
validations:
28+
required: true
29+
- type: input
30+
id: sdk-version
31+
attributes:
32+
label: SDK version number
33+
value: "@aws-sdk/package-name@version, ..."
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: runtime
38+
attributes:
39+
label: Which JavaScript Runtime is this issue in?
40+
options:
41+
- Node.js
42+
- Browser
43+
- React Native
44+
validations:
45+
required: true
46+
- type: input
47+
id: runtime-version
48+
attributes:
49+
label: Details of the browser/Node.js/ReactNative version
50+
description: Paste output of `node -v` or `npx envinfo --browsers` or `react-native -v`
1351
validations:
1452
required: true
1553
- type: textarea
16-
id: expected
54+
id: reproduction
1755
attributes:
18-
label: Expected Behavior
56+
label: Reproduction Steps
1957
description: |
20-
What did you expect to happen?
58+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
59+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
60+
61+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
62+
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.
2163
validations:
2264
required: true
2365
- type: textarea
24-
id: current
66+
id: observed-behavior
2567
attributes:
26-
label: Current Behavior
68+
label: Observed Behavior
2769
description: |
2870
What actually happened?
2971
@@ -32,15 +74,11 @@ body:
3274
validations:
3375
required: true
3476
- type: textarea
35-
id: reproduction
77+
id: expected-behavior
3678
attributes:
37-
label: Reproduction Steps
79+
label: Expected Behavior
3880
description: |
39-
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40-
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41-
42-
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.
81+
What did you expect to happen?
4482
validations:
4583
required: true
4684
- type: textarea
@@ -59,15 +97,3 @@ body:
5997
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.
6098
validations:
6199
required: false
62-
- type: input
63-
id: sdk-version
64-
attributes:
65-
label: SDK version used
66-
validations:
67-
required: true
68-
- type: input
69-
id: environment
70-
attributes:
71-
label: Environment details (OS name and version, etc.)
72-
validations:
73-
required: true

0 commit comments

Comments
 (0)