Skip to content

chore: update issue, PR, and discussion templates #1915

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
name: Request for Comments (RFC)
description: Feature design and detailed proposals
title: "RFC: TITLE"
labels: ["RFC", "triage"]
title: "RFC: <Title>"
body:
- type: markdown
attributes:
Expand All @@ -15,21 +12,18 @@ body:
- type: dropdown
id: area
attributes:
label: Which Powertools for AWS Lambda (Java) utility does this relate to?
label: Which area does this RFC relate to?
options:
- Tracer
- Logger
- Metrics
- Middleware factory
- Parameters
- Batch processing
- Typing
- Large Messages
- Batch Processing
- Validation
- Event Source Data Classes
- Parser
- Idempotency
- Feature flags
- JMESPath functions
- Custom Resources
- Serialization
- Other
validations:
required: true
Expand Down Expand Up @@ -81,15 +75,15 @@ body:
attributes:
label: Alternative solutions
description: Please describe what alternative solutions to this use case, if any
render: markdown
render: Markdown
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: This feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/Java/#tenets)
- label: This RFC meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/java/latest/#tenets)
required: true
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [TypeScript](https://github.com/aws-powertools/powertools-lambda-typescript/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/)
required: false
Expand All @@ -98,10 +92,16 @@ body:
value: |
---

**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
**Disclaimer**: After creating an RFC, please wait until it is reviewed and signed-off by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.

Metadata information for admin purposes, please leave them empty.

* RFC PR:
* Approved by: ''
* Reviewed by: ''
* Reviewed by: ''
- type: input
id: notes
attributes:
label: Future readers
description: Please not edit this field
value: "Please react with 👍 and your use case to help us understand customer demand."
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Bug report
description: Report a reproducible bug to help us improve
title: "Bug: TITLE"
type: "Bug"
labels: ["bug", "triage"]
body:
- type: markdown
Expand Down Expand Up @@ -49,7 +50,7 @@ body:
id: version
attributes:
label: Powertools for AWS Lambda (Java) version
placeholder: "latest, 1.19.0"
placeholder: "latest, 2.0.1"
value: latest
validations:
required: true
Expand Down
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@ blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/aws-powertools/powertools-lambda-java/discussions/new
about: Ask a general question about Lambda Powertools
about: Ask a general question about Powertools for AWS Lambda
- name: Join Community Discord Server
url: https://discord.gg/B8zZKbbyET
about: "Check out the #java channel"
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Feature request
description: Suggest an idea for Powertools for AWS Lambda
title: "Feature request: TITLE"
labels: ["feature-request", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest an idea to the Powertools for AWS Lambda (Java) project.
- type: textarea
id: problem
attributes:
label: Use case
description: Please help us understand your use case or problem you're facing
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Solution/User Experience
description: Please share what a good solution would look like to this use case
validations:
required: true
- 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 feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/java/latest/#tenets)
required: true
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [TypeScript](https://github.com/aws-powertools/powertools-lambda-typescript/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/)
required: false
- type: markdown
attributes:
value: |
---

**Disclaimer**: After creating an issue, please wait until it is triaged and confirmed by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.
- type: input
id: notes
attributes:
label: Future readers
description: Please not edit this field
value: "Please react with 👍 and your use case to help us understand customer demand."
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/share_your_work.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: I Made This (showcase your work)
description: Share what you did with Powertools for AWS Lambda (Java) 💞💞. Blog post, workshops, presentation, sample apps, etc.
title: "[I Made This]: <TITLE>"
labels: ["community-content"]
labels: ["community-content", "triage"]
body:
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support_powertools.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Support Powertools for AWS Lambda (Java) (become a reference)
description: Add your organization's name or logo to the Powertools for AWS Lambda (Java) documentation
title: "[Support Powertools for AWS Lambda (Java)]: <your organization name>"
labels: ["customer-reference"]
labels: ["customer-reference", "triage"]
body:
- type: markdown
attributes:
Expand Down
33 changes: 18 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
**Issue #, if available:**
## Summary

## Description of changes:
### Changes

<!--- One or two sentences as a summary of what's being changed -->
> Please provide a summary of what's being changed

**Checklist**
<!-- What is this PR solving? Write a clear description or reference the issue(s) it addresses. -->

<!--- Leave unchecked if your change doesn't seem to apply -->
> Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

* [ ] [Meet tenets criteria](https://docs.powertools.aws.dev/lambda-java/#tenets)
* [ ] Update tests
* [ ] Update docs
* [ ] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0/)
**Issue number:**

## Breaking change checklist
<!-------
Before creating the pull request, please make sure you do the following:

<!--- Ignore if it's not a breaking change -->
- Read the Contributing Guidelines at https://github.com/aws-powertools/powertools-lambda-java/blob/main/CONTRIBUTING.md#sending-a-pull-request
- Check that there isn't already a PR that addresses the same issue. If you find a duplicate, please leave a comment under the existing PR so we can discuss how to move forward
- Check that the change meets the project's tenets https://docs.powertools.aws.dev/lambda/java/latest/#tenets
- Add a PR title that follows the conventional commit semantics - https://www.conventionalcommits.org/en/v1.0.0/
- If relevant, add tests that prove that the change is effective and works
- Whenever relevant, make sure to comment functions/methods/types and make appropriate changes to the documentation
------->

**RFC issue #**:

* [ ] Migration process documented
* [ ] Implement warnings (if it can live side by side)
---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.