Skip to content

Commit b028b2c

Browse files
authored
Add generic bug report and feature request templates (#343)
1 parent 00f8a8e commit b028b2c

File tree

3 files changed

+121
-1
lines changed

3 files changed

+121
-1
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug Report (generic)
2+
description: Create a report to help us improve
3+
title: "[Bug?]: "
4+
labels: ["bug", "triage"]
5+
6+
body:
7+
- type: checkboxes
8+
id: selfservice
9+
attributes:
10+
label: Self-service
11+
description: "Fixing bugs is always a great way to give back to open-source projects, and we're more than happy to answer questions and provide context."
12+
options:
13+
- label: "I'd be willing to implement a fix"
14+
15+
- type: textarea
16+
attributes:
17+
label: Describe the bug
18+
description: |
19+
A clear and concise description of what the bug is. A bug is **unintended**. A feature not being implemented is **not a bug**.
20+
placeholder: |
21+
eg: aws-sdk-js-codemod crashes with a specific error.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: Steps to reproduce
28+
description: The _minimal_ steps to reproduce your issue.
29+
placeholder: |
30+
Please share code or minimal repo, and steps to reproduce the behavior.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: Observed behavior
37+
description: A clear and concise description of what happens.
38+
placeholder: |
39+
eg: The aws-sdk-js-codemod script returned error with the following stack trace:
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: Expected behavior
46+
description: A clear and concise description of what you were expecting to happen.
47+
placeholder: |
48+
eg: The aws-sdk-js-codemod script should have run successfully.
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
attributes:
54+
label: Environment
55+
render: shell
56+
description: |
57+
Run `aws-sdk-js-codemod --version` and paste the result into the form
58+
placeholder: |
59+
aws-sdk-js-codemod: 0.10.2
60+
61+
jscodeshift: 0.14.0
62+
- babel: 7.20.12
63+
- babylon: 7.20.7
64+
- flow: 0.196.3
65+
- recast: 0.21.5
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
attributes:
71+
label: Additional context
72+
description: |
73+
Add any other context about the problem here. Or a screenshot if applicable.

.github/ISSUE_TEMPLATE/bug_report_transform.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ body:
6060
- type: textarea
6161
attributes:
6262
label: Expected output
63-
description: Thw output file you expected to see.
63+
description: The output file you expected to see.
6464
placeholder: |
6565
```ts
6666
import { DynamoDB } from "@aws-sdk/client-dynamodb";
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Feature Request (generic)
2+
description: This is a generic feature request for aws-sdk-js-codemod.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: checkboxes
8+
id: selfservice
9+
attributes:
10+
label: Self-service
11+
description: "Adding features is a great way to give back to open-source projects, and we're more than happy to answer questions and provide context."
12+
options:
13+
- label: "I'd be willing to implement this feature"
14+
15+
- type: textarea
16+
attributes:
17+
label: Problem
18+
description: |
19+
Is your feature request related to a problem? Please describe.
20+
placeholder: |
21+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: Solution
28+
description: Describe the solution you'd like.
29+
placeholder: |
30+
A clear and concise description of what you want to happen.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: Alternatives
37+
description: Describe alternatives you've considered
38+
placeholder: |
39+
A clear and concise description of any alternative solutions or features you've considered.
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: Additional context
46+
description: |
47+
Add any other context about the problem here. Or a screenshot if applicable.

0 commit comments

Comments
 (0)