Skip to content

Commit 9ce6a73

Browse files
authored
Update bug report template (#18)
1 parent 2652913 commit 9ce6a73

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,50 @@ body:
1818
description: |
1919
A clear and concise description of what the bug is. A bug is **unintended**. A feature not being implemented is **not a bug**.
2020
placeholder: |
21-
eg: Running aws-sdk-js-v2-to-v3 transform on provided input causes it to crash.
21+
eg: Running transform "transformName" on the provided input causes it to crash.
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
id: template-name
27+
attributes:
28+
label: Template name
29+
description: Which template are you seeing this error for?
30+
options:
31+
- v2-to-v3
32+
- N/A (described above)
2233
validations:
2334
required: true
2435

2536
- type: textarea
2637
attributes:
27-
label: Steps to reproduce
28-
description: |
29-
The _minimal_ information needed to reproduce your issue (ideally provided input, and expected output).
38+
label: Input code
39+
description: The _minimal_ input file to reproduce your issue.
3040
placeholder: |
31-
### Input
3241
```ts
3342
import AWS from "aws-sdk";
3443
3544
const region = "us-west-2";
3645
const client = new AWS.DynamoDB({ region });
3746
const response = await client.listTables({}).promise();
3847
```
48+
validations:
49+
required: true
3950

40-
### Observed Output
41-
```ts
42-
```
51+
- type: textarea
52+
attributes:
53+
label: Observed failure
54+
description: A concise description of what error you're experiencing.
55+
placeholder: |
56+
eg: The aws-sdk-js-codemod script returned the following error:
57+
validations:
58+
required: true
4359

60+
- type: textarea
61+
attributes:
62+
label: Expected output
63+
description: Thw output file you expected to see.
64+
placeholder: |
4465
### Expected Output
4566
```ts
4667
import { DynamoDB } from "@aws-sdk/client-dynamodb";
@@ -57,9 +78,9 @@ body:
5778
label: Environment
5879
render: shell
5980
description: |
60-
Run `node -v` and `jscodeshift -v` and paste the result into the form
81+
Run `aws-sdk-js-codemod --version` and paste the result into the form
6182
placeholder: |
62-
node version: v16.14.0
83+
aws-sdk-js-codemod: 0.1.0
6384
6485
jscodeshift: 0.13.1
6586
- babel: 7.17.5

0 commit comments

Comments
 (0)