Skip to content

chore(governance): update issue templates #1062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/awslabs/aws-lambda-powertools-java/discussions/new
about: Ask a general question about Lambda Powertools
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/documentation-improvements.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvements.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Documentation improvements
description: Suggest a documentation update to improve everyone's experience
title: "Docs: TITLE"
labels: ["documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for helping us improve everyone's experience. We review documentation updates on a case by case basis.
- type: textarea
id: search_area
attributes:
label: What were you searching in the docs?
description: Please help us understand how you looked for information that was either unclear or not available
validations:
required: true
- type: input
id: area
attributes:
label: Is this related to an existing documentation section?
description: Please share a link, if applicable
validations:
required: false
- type: textarea
id: idea
attributes:
label: How can we improve?
description: Please share your thoughts on how we can improve this experience
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Got a suggestion in mind?
description: Please suggest a proposed update
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: I understand the final update might be different from my proposed suggestion, or refused.
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.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Maintenance
description: Suggest an activity to help address tech debt, governance, and anything internal
title: "Maintenance: TITLE"
labels: ["internal", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to help us improve operational excellence.

*Future readers*: Please react with 👍 and your use case to help us understand customer demand.
- type: textarea
id: activity
attributes:
label: Summary
description: Please provide an overview in one or two paragraphs
validations:
required: true
- type: textarea
id: importance
attributes:
label: Why is this needed?
description: Please help us understand the value so we can prioritize it accordingly
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area does this relate to?
multiple: true
options:
- Automation
- Governance
- Tests
- Tracer
- Logger
- Metrics
- Parameters
- SQS Large Message Handling
- SQS Batch Processing
- Validation
- Idempotency
- Custom Resources
- Serialization
- Other
- type: textarea
id: suggestion
attributes:
label: Solution
description: If available, please share what a good solution would look like
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-java/#tenets)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
required: false
- 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.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/share_your_work.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: I Made This (showcase your work)
description: Share what you did with Powertools 💞💞. Blog post, workshops, presentation, sample apps, etc.
title: "[I Made This]: <TITLE>"
labels: ["community-content"]
body:
- type: markdown
attributes:
value: Thank you for helping spread the word out on Powertools, truly!
- type: input
id: content
attributes:
label: Link to your material
description: |
Please share the original link to your material.

*Note: Short links will be expanded when added to Powertools documentation*
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe in one paragraph what's in it for them (readers)
validations:
required: true
- type: input
id: author
attributes:
label: Preferred contact
description: What's your preferred contact? We'll list it next to this content
validations:
required: true
- type: input
id: author-social
attributes:
label: (Optional) Social Network
description: If different from preferred contact, what's your preferred contact for social interactions?
validations:
required: false
- type: textarea
id: notes
attributes:
label: (Optional) Additional notes
description: |
Any notes you might want to share with us related to this material.

*Note: These notes are explicitly to Powertools maintainers. It will not be added to the community resources page.*
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: I understand this content may be removed from Powertools documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
required: true