Skip to content

Commit 3b7115d

Browse files
kaizencckaizencc
authored
chore: github issue templates (#153)
Grrr, no projen support: projen/projen#3567. I'm lazy so I just copied and pasted a few from the aws-cdk repo. This is somewhat necessary because it adds the `needs-triage` label automatically, that my other PR will need: #118 --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
1 parent fdf54d0 commit 3b7115d

File tree

3 files changed

+261
-0
lines changed

3 files changed

+261
-0
lines changed

‎.github/ISSUE_TEMPLATES/bug-report.yml‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(module name): (short issue description)"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
13+
**⚠️ Please read this before filling out the form below:**
14+
If the bug you are reporting is a security-related issue or a security vulnerability,
15+
please report it via [Report a security vulnerability](https://github.com/aws/aws-cdk/security/advisories/new) instead of this template.
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the bug
20+
description: What is the problem? A clear and concise description of the bug.
21+
validations:
22+
required: true
23+
- type: checkboxes
24+
id: regression
25+
attributes:
26+
label: Regression Issue
27+
description: What is a regression? If it worked in a previous version but doesn’t in the latest version, it’s considered a regression. In this case, please provide specific version number in the report.
28+
options:
29+
- label: Select this option if this issue appears to be a regression.
30+
required: false
31+
- type: input
32+
id: working-version
33+
attributes:
34+
label: Last Known Working CDK Version
35+
description: Specify the last known CDK version where this code was functioning as expected (if applicable).
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Expected Behavior
42+
description: |
43+
What did you expect to happen?
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: current
48+
attributes:
49+
label: Current Behavior
50+
description: |
51+
What actually happened?
52+
53+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
54+
If service responses are relevant, please include wire logs.
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: reproduction
59+
attributes:
60+
label: Reproduction Steps
61+
description: |
62+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
63+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
64+
65+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
66+
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.
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: solution
71+
attributes:
72+
label: Possible Solution
73+
description: |
74+
Suggest a fix/reason for the bug
75+
validations:
76+
required: false
77+
- type: textarea
78+
id: context
79+
attributes:
80+
label: Additional Information/Context
81+
description: |
82+
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.
83+
validations:
84+
required: false
85+
86+
- type: input
87+
id: cdk-version
88+
attributes:
89+
label: CDK CLI Version
90+
description: Output of `cdk version`
91+
validations:
92+
required: true
93+
94+
- type: input
95+
id: framework-version
96+
attributes:
97+
label: Framework Version
98+
validations:
99+
required: false
100+
101+
- type: input
102+
id: node-version
103+
attributes:
104+
label: Node.js Version
105+
validations:
106+
required: true
107+
108+
- type: input
109+
id: operating-system
110+
attributes:
111+
label: OS
112+
validations:
113+
required: true
114+
115+
- type: dropdown
116+
id: language
117+
attributes:
118+
label: Language
119+
multiple: true
120+
options:
121+
- TypeScript
122+
- Python
123+
- .NET
124+
- Java
125+
- Go
126+
validations:
127+
required: true
128+
129+
- type: input
130+
id: language-version
131+
attributes:
132+
label: Language Version
133+
description: E.g. TypeScript (3.8.3) | Java (8) | Python (3.7.3)
134+
validations:
135+
required: false
136+
137+
- type: textarea
138+
id: other
139+
attributes:
140+
label: Other information
141+
description: |
142+
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
143+
validations:
144+
required: false

‎.github/ISSUE_TEMPLATES/feature-request.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(module name): (short issue description)"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false
48+
- type: input
49+
id: sdk-version
50+
attributes:
51+
label: CDK version used
52+
validations:
53+
required: true
54+
- type: input
55+
id: environment
56+
attributes:
57+
label: Environment details (OS name and version, etc.)
58+
validations:
59+
required: true

‎.github/ISSUE_TEMPLATES/notice.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: "❗ Notice"
3+
description: Post a notice for a high impact issue. Internal CDK team use only.
4+
title: "❗ NOTICE (module name): (short notice description)"
5+
labels: [needs-triage, management/tracking]
6+
body:
7+
- type: dropdown
8+
attributes:
9+
label: Status
10+
description: What is the current status of this issue?
11+
options:
12+
- Investigating (Default)
13+
- In-Progress
14+
- Resolved
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: What is the issue?
20+
description: A clear and concise description of the issue you want customers to be aware of
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Error message
26+
description: If available, paste the error message users are seeing (no need to backticks)
27+
render: console
28+
- type: textarea
29+
attributes:
30+
label: What is the impact?
31+
description: |
32+
What can occur if this issue isn't addressed?
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Workaround
38+
description: |
39+
Please provide a detailed workaround outlining all steps required for implementation. If none exist yet, leave blank
40+
- type: textarea
41+
attributes:
42+
label: Who is affected?
43+
description: |
44+
What segment of customers are affected? Think about specific construct usage, version, feature toggles, etc...
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: How do I resolve this?
50+
description: |
51+
What actions should customers take to resolve the issue. Also elaborate on any code changes the customer may need to do. If unknown yet, say TBD
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: Related issues
57+
description: |
58+
List all related issues here. If none related, leave blank

0 commit comments

Comments
 (0)