Skip to content
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

chore(automation): Update issue templates #1779

Open
wants to merge 1 commit 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
132 changes: 89 additions & 43 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,92 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug, triage
assignees: ''
description: Report a reproducible bug to help us improve
title: "Bug: TITLE"
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a bug report. Please add as much information as possible to help us reproduce, and remove any potential sensitive data.

---
Please become familiar with [our definition of bug](https://docs.powertools.aws.dev/lambda/java/processes/maintainers/#is-that-a-bug).
- type: textarea
id: expected_behaviour
attributes:
label: Expected Behaviour
description: Please share details on the behaviour you expected
validations:
required: true
- type: textarea
id: current_behaviour
attributes:
label: Current Behaviour
description: Please share details on the current issue
validations:
required: true
- type: textarea
id: code_snippet
attributes:
label: Code snippet
description: Please share a code snippet to help us reproduce the issue
render: java
validations:
required: true
- type: textarea
id: solution
attributes:
label: Possible Solution
description: If known, please suggest a potential resolution
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Please share how we might be able to reproduce this issue
validations:
required: true
- type: input
id: version
attributes:
label: Powertools for AWS Lambda (Java) version
placeholder: "latest, 1.19.0"
value: latest
validations:
required: true
- type: dropdown
id: runtime
attributes:
label: AWS Lambda function runtime
options:
- "Java 8"
- "Java 11"
- "Java 17"
- "Java 21"
- "provided.al2023"
validations:
required: true
- type: dropdown
id: packaging
attributes:
label: Packaging format used
options:
- Lambda Layers
- Serverless Application Repository (SAR) App
- PyPi
multiple: true
validations:
required: true
- type: textarea
id: logs
attributes:
label: Debugging logs
description: If available, please share [debugging logs](https://docs.powertools.aws.dev/lambda/lambda/#debug-mode)
render: java
validations:
required: false
- type: markdown
attributes:
value: |
---

<!--- Provide a general summary of the issue in the Title above -->
<!--- How has this issue affected you? What are you trying to accomplish? -->

**What were you trying to accomplish?**

## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Environment

* **Powertools for AWS Lambda (Java) version used**:
* **Packaging format (Layers, Maven/Gradle)**:
* **AWS Lambda function runtime:**
* **Debugging logs**

> [How to enable debug mode](https://docs.powertools.aws.dev/lambda-java/#debug-mode)**

```text
# paste logs here
```
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ body:
options:
- label: This request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda-java/#tenets)
required: true
- label: Should this be considered in other Powertools for AWS Lambda (Java) languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [TypeScript](https://github.com/aws-powertools/powertools-lambda-typescript/)
- 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/)
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.
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
159 changes: 107 additions & 52 deletions .github/ISSUE_TEMPLATE/rfc.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,107 @@
---
name: RFC
about: Feature design and proposals
title: 'RFC: '
labels: RFC, triage
assignees: ''

---

## Key information

* RFC PR: (leave this empty)
* Related issue(s), if known:
* Area: (i.e. Tracer, Metrics, Logger, etc.)
* Meet [tenets](https://docs.powertools.aws.dev/lambda-java/#tenets): (Yes/no)

## Summary
[summary]: #summary

> One paragraph explanation of the feature.

## Motivation
[motivation]: #motivation

> Why are we doing this? What use cases does it support? What is the expected outcome?

## Proposal
[proposal]: #proposal

> This is the bulk of the RFC.

> Explain the design in enough detail for somebody familiar with Powertools for AWS Lambda (Java) to understand it, and for somebody familiar with the implementation to implement it.

> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.

## Drawbacks
[drawbacks]: #drawbacks

> Why should we *not* do this?

> Do we need additional dependencies? Impact performance/package size?

## Rationale and alternatives
[rationale-and-alternatives]: #rationale-and-alternatives

* **What other designs have been considered? Why not them?**
* **What is the impact of not doing this?**

## Unresolved questions
[unresolved-questions]: #unresolved-questions

> Optional, stash area for topics that need further development e.g. TBD
name: Request for Comments (RFC)
description: Feature design and detailed proposals
title: "RFC: TITLE"
labels: ["RFC", "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: dropdown
id: area
attributes:
label: Which Powertools for AWS Lambda (Java) utility does this relate to?
options:
- Tracer
- Logger
- Metrics
- Middleware factory
- Parameters
- Batch processing
- Typing
- Validation
- Event Source Data Classes
- Parser
- Idempotency
- Feature flags
- JMESPath functions
- Other
validations:
required: true
- 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 feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/Java/#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**: 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: ''
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/share_your_work.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ body:
label: Acknowledgment
options:
- label: I understand this content may be removed from Powertools for AWS Lambda (Java) documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
required: true
required: true
8 changes: 4 additions & 4 deletions .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"]
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -48,9 +48,9 @@ body:
- type: checkboxes
id: other_languages
attributes:
label: Also using other Powertools for AWS Lambda (Java) languages?
label: Also using other Powertools for AWS Lambda languages?
options:
- label: Python
- label: Java
required: false
- label: TypeScript
required: false
Expand All @@ -59,6 +59,6 @@ body:
- type: markdown
attributes:
value: |
*By raising a Support Powertools for AWS Lambda (Java) 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.*
*By raising a Support Powertools for AWS Lambda (Python) 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.*
Loading