Skip to content

Commit b314bfd

Browse files
authored
chore(issues): add new templates to for issues (#977)
* chore(issue): add new template for issues
1 parent 251c3ca commit b314bfd

File tree

2 files changed

+152
-0
lines changed

2 files changed

+152
-0
lines changed

.github/ISSUE_TEMPLATE/rfc.yml

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: 🚧 Request for Comments (RFC)
2+
description: Feature design and detailed proposals
3+
title: "RFC: TITLE"
4+
labels: ["RFC-proposal", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a RFC. Please add as many details as possible to help further enrich this design.
10+
- type: input
11+
id: relation
12+
attributes:
13+
label: Is this related to an existing feature request or issue?
14+
description: Please share a link, if applicable
15+
- type: textarea
16+
id: summary
17+
attributes:
18+
label: Summary
19+
description: Please provide an overview in one or two paragraphs
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: Use case
26+
description: Please share the use case and motivation behind this proposal
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: proposal
31+
attributes:
32+
label: Proposal
33+
description: Please explain the design in detail, so anyone familiar with the project could implement it
34+
placeholder: What the user experience looks like before and after this design?
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: scope
39+
attributes:
40+
label: Out of scope
41+
description: Please explain what should be considered out of scope in your proposal
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: challenges
46+
attributes:
47+
label: Potential challenges
48+
description: Nothing is perfect. Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: integrations
53+
attributes:
54+
label: Dependencies and Integrations
55+
description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available
56+
validations:
57+
required: false
58+
- type: textarea
59+
id: alternatives
60+
attributes:
61+
label: Alternative solutions
62+
description: Please describe what alternative solutions to this use case, if any
63+
render: markdown
64+
validations:
65+
required: false
66+
- type: checkboxes
67+
id: acknowledgment
68+
attributes:
69+
label: Acknowledgment
70+
options:
71+
- label: This RFC proposal meets [GenAI CDK constructs design guidelines](https://github.com/awslabs/generative-ai-cdk-constructs/blob/main/DESIGN_GUIDELINES.md)
72+
required: true
73+
- type: markdown
74+
attributes:
75+
value: |
76+
---
77+
78+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
79+
80+
Metadata information for admin purposes, please leave them empty.
81+
82+
* RFC PR:
83+
* Approved by: ''
84+
* Reviewed by: ''
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: 💞 Support Generative AI CDK constructs (become a reference)
2+
description: Add your organization's name or logo to the Generative AI CDK constructs documentation
3+
title: "[Support Generative AI CDK constructs]: <your organization name>"
4+
labels: ["customer-reference"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for becoming a reference customer. Your support means a lot to us. It also helps new customers to know who's using it.
10+
11+
If you would like us to also display your organization's logo, please share a link in the `Company logo` field.
12+
- type: input
13+
id: organization
14+
attributes:
15+
label: Organization Name
16+
description: Please share the name of your organization
17+
placeholder: ACME
18+
validations:
19+
required: true
20+
- type: input
21+
id: name
22+
attributes:
23+
label: Your Name
24+
description: Please share your name
25+
validations:
26+
required: true
27+
- type: input
28+
id: job
29+
attributes:
30+
label: Your current position
31+
description: Please share your current position at your company
32+
validations:
33+
required: true
34+
- type: input
35+
id: logo
36+
attributes:
37+
label: (Optional) Company logo
38+
description: Company logo you want us to display. You also allow us to resize for optimal placement in the documentation.
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: use_case
43+
attributes:
44+
label: (Optional) Use case
45+
description: How are you using Generative AI CDK constructs today? *features, etc.*
46+
validations:
47+
required: false
48+
- type: checkboxes
49+
id: languages
50+
attributes:
51+
label: What languages are you using for Generative AI CDK constructs?
52+
options:
53+
- label: Java
54+
required: false
55+
- label: Go
56+
required: false
57+
- label: TypeScript
58+
required: false
59+
- label: .NET
60+
required: false
61+
- label: Python
62+
required: false
63+
- type: markdown
64+
attributes:
65+
value: |
66+
*By raising a Support Generative AI CDK constructs issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.*
67+
68+
*You can opt-out at any time by commenting or reopening this issue.*

0 commit comments

Comments
 (0)