Skip to content

Commit

Permalink
chore(issues): add new templates to for issues (#977)
Browse files Browse the repository at this point in the history
* chore(issue): add new template for issues
  • Loading branch information
krokoko authored Feb 20, 2025
1 parent 251c3ca commit b314bfd
Show file tree
Hide file tree
Showing 2 changed files with 152 additions and 0 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: 🚧 Request for Comments (RFC)
description: Feature design and detailed proposals
title: "RFC: TITLE"
labels: ["RFC-proposal", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a RFC. Please add as many details as possible to help further enrich this design.
- type: input
id: relation
attributes:
label: Is this related to an existing feature request or issue?
description: Please share a link, if applicable
- type: textarea
id: summary
attributes:
label: Summary
description: Please provide an overview in one or two paragraphs
validations:
required: true
- type: textarea
id: problem
attributes:
label: Use case
description: Please share the use case and motivation behind this proposal
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposal
description: Please explain the design in detail, so anyone familiar with the project could implement it
placeholder: What the user experience looks like before and after this design?
validations:
required: true
- type: textarea
id: scope
attributes:
label: Out of scope
description: Please explain what should be considered out of scope in your proposal
validations:
required: true
- type: textarea
id: challenges
attributes:
label: Potential challenges
description: Nothing is perfect. Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them
validations:
required: true
- type: textarea
id: integrations
attributes:
label: Dependencies and Integrations
description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternative solutions
description: Please describe what alternative solutions to this use case, if any
render: markdown
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: This RFC proposal meets [GenAI CDK constructs design guidelines](https://github.com/awslabs/generative-ai-cdk-constructs/blob/main/DESIGN_GUIDELINES.md)
required: true
- type: markdown
attributes:
value: |
---
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
Metadata information for admin purposes, please leave them empty.
* RFC PR:
* Approved by: ''
* Reviewed by: ''
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/support_genai_cdk_constructs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: 💞 Support Generative AI CDK constructs (become a reference)
description: Add your organization's name or logo to the Generative AI CDK constructs documentation
title: "[Support Generative AI CDK constructs]: <your organization name>"
labels: ["customer-reference"]
body:
- type: markdown
attributes:
value: |
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.
If you would like us to also display your organization's logo, please share a link in the `Company logo` field.
- type: input
id: organization
attributes:
label: Organization Name
description: Please share the name of your organization
placeholder: ACME
validations:
required: true
- type: input
id: name
attributes:
label: Your Name
description: Please share your name
validations:
required: true
- type: input
id: job
attributes:
label: Your current position
description: Please share your current position at your company
validations:
required: true
- type: input
id: logo
attributes:
label: (Optional) Company logo
description: Company logo you want us to display. You also allow us to resize for optimal placement in the documentation.
validations:
required: false
- type: textarea
id: use_case
attributes:
label: (Optional) Use case
description: How are you using Generative AI CDK constructs today? *features, etc.*
validations:
required: false
- type: checkboxes
id: languages
attributes:
label: What languages are you using for Generative AI CDK constructs?
options:
- label: Java
required: false
- label: Go
required: false
- label: TypeScript
required: false
- label: .NET
required: false
- label: Python
required: false
- type: markdown
attributes:
value: |
*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.*
*You can opt-out at any time by commenting or reopening this issue.*

0 comments on commit b314bfd

Please sign in to comment.