Skip to content

Commit 2fe2fe2

Browse files
sthulbsthulb
committed
chore(automation): Update issue templates
1 parent 394ab0c commit 2fe2fe2

File tree

6 files changed

+263
-102
lines changed

6 files changed

+263
-102
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+89-43
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,92 @@
1-
---
21
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: bug, triage
6-
assignees: ''
2+
description: Report a reproducible bug to help us improve
3+
title: "Bug: TITLE"
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a bug report. Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
710

8-
---
11+
Please become familiar with [our definition of bug](https://docs.powertools.aws.dev/lambda/java/processes/maintainers/#is-that-a-bug).
12+
- type: textarea
13+
id: expected_behaviour
14+
attributes:
15+
label: Expected Behaviour
16+
description: Please share details on the behaviour you expected
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: current_behaviour
21+
attributes:
22+
label: Current Behaviour
23+
description: Please share details on the current issue
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: code_snippet
28+
attributes:
29+
label: Code snippet
30+
description: Please share a code snippet to help us reproduce the issue
31+
render: java
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: solution
36+
attributes:
37+
label: Possible Solution
38+
description: If known, please suggest a potential resolution
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: Steps to Reproduce
45+
description: Please share how we might be able to reproduce this issue
46+
validations:
47+
required: true
48+
- type: input
49+
id: version
50+
attributes:
51+
label: Powertools for AWS Lambda (Java) version
52+
placeholder: "latest, 1.19.0"
53+
value: latest
54+
validations:
55+
required: true
56+
- type: dropdown
57+
id: runtime
58+
attributes:
59+
label: AWS Lambda function runtime
60+
options:
61+
- "Java 8"
62+
- "Java 11"
63+
- "Java 17"
64+
- "Java 21"
65+
- "provided.al2023"
66+
validations:
67+
required: true
68+
- type: dropdown
69+
id: packaging
70+
attributes:
71+
label: Packaging format used
72+
options:
73+
- Lambda Layers
74+
- Serverless Application Repository (SAR) App
75+
- PyPi
76+
multiple: true
77+
validations:
78+
required: true
79+
- type: textarea
80+
id: logs
81+
attributes:
82+
label: Debugging logs
83+
description: If available, please share [debugging logs](https://docs.powertools.aws.dev/lambda/lambda/#debug-mode)
84+
render: java
85+
validations:
86+
required: false
87+
- type: markdown
88+
attributes:
89+
value: |
90+
---
991

10-
<!--- Provide a general summary of the issue in the Title above -->
11-
<!--- How has this issue affected you? What are you trying to accomplish? -->
12-
13-
**What were you trying to accomplish?**
14-
15-
## Expected Behavior
16-
<!--- If you're describing a bug, tell us what should happen -->
17-
<!--- If you're suggesting a change/improvement, tell us how it should work -->
18-
19-
## Current Behavior
20-
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21-
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
22-
23-
## Possible Solution
24-
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
25-
<!--- or ideas how to implement the addition or change -->
26-
27-
## Steps to Reproduce (for bugs)
28-
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
29-
<!--- reproduce this bug. Include code to reproduce, if relevant -->
30-
1.
31-
2.
32-
3.
33-
4.
34-
35-
## Environment
36-
37-
* **Powertools for AWS Lambda (Java) version used**:
38-
* **Packaging format (Layers, Maven/Gradle)**:
39-
* **AWS Lambda function runtime:**
40-
* **Debugging logs**
41-
42-
> [How to enable debug mode](https://docs.powertools.aws.dev/lambda-java/#debug-mode)**
43-
44-
```text
45-
# paste logs here
46-
```
92+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/maintenance.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ body:
5757
options:
5858
- label: This request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda-java/#tenets)
5959
required: true
60-
- 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/)
60+
- 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/)
6161
required: false
6262
- type: markdown
6363
attributes:
6464
value: |
6565
---
6666
67-
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
67+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/rfc.md

+107-52
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,107 @@
1-
---
2-
name: RFC
3-
about: Feature design and proposals
4-
title: 'RFC: '
5-
labels: RFC, triage
6-
assignees: ''
7-
8-
---
9-
10-
## Key information
11-
12-
* RFC PR: (leave this empty)
13-
* Related issue(s), if known:
14-
* Area: (i.e. Tracer, Metrics, Logger, etc.)
15-
* Meet [tenets](https://docs.powertools.aws.dev/lambda-java/#tenets): (Yes/no)
16-
17-
## Summary
18-
[summary]: #summary
19-
20-
> One paragraph explanation of the feature.
21-
22-
## Motivation
23-
[motivation]: #motivation
24-
25-
> Why are we doing this? What use cases does it support? What is the expected outcome?
26-
27-
## Proposal
28-
[proposal]: #proposal
29-
30-
> This is the bulk of the RFC.
31-
32-
> 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.
33-
34-
> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
35-
36-
## Drawbacks
37-
[drawbacks]: #drawbacks
38-
39-
> Why should we *not* do this?
40-
41-
> Do we need additional dependencies? Impact performance/package size?
42-
43-
## Rationale and alternatives
44-
[rationale-and-alternatives]: #rationale-and-alternatives
45-
46-
* **What other designs have been considered? Why not them?**
47-
* **What is the impact of not doing this?**
48-
49-
## Unresolved questions
50-
[unresolved-questions]: #unresolved-questions
51-
52-
> Optional, stash area for topics that need further development e.g. TBD
1+
name: Request for Comments (RFC)
2+
description: Feature design and detailed proposals
3+
title: "RFC: TITLE"
4+
labels: ["RFC", "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: dropdown
16+
id: area
17+
attributes:
18+
label: Which Powertools for AWS Lambda (Java) utility does this relate to?
19+
options:
20+
- Tracer
21+
- Logger
22+
- Metrics
23+
- Middleware factory
24+
- Parameters
25+
- Batch processing
26+
- Typing
27+
- Validation
28+
- Event Source Data Classes
29+
- Parser
30+
- Idempotency
31+
- Feature flags
32+
- JMESPath functions
33+
- Other
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: summary
38+
attributes:
39+
label: Summary
40+
description: Please provide an overview in one or two paragraphs
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: problem
45+
attributes:
46+
label: Use case
47+
description: Please share the use case and motivation behind this proposal
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: proposal
52+
attributes:
53+
label: Proposal
54+
description: Please explain the design in detail, so anyone familiar with the project could implement it
55+
placeholder: What the user experience looks like before and after this design?
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: scope
60+
attributes:
61+
label: Out of scope
62+
description: Please explain what should be considered out of scope in your proposal
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: challenges
67+
attributes:
68+
label: Potential challenges
69+
description: Nothing is perfect. Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them
70+
validations:
71+
required: true
72+
- type: textarea
73+
id: integrations
74+
attributes:
75+
label: Dependencies and Integrations
76+
description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available
77+
validations:
78+
required: false
79+
- type: textarea
80+
id: alternatives
81+
attributes:
82+
label: Alternative solutions
83+
description: Please describe what alternative solutions to this use case, if any
84+
render: markdown
85+
validations:
86+
required: false
87+
- type: checkboxes
88+
id: acknowledgment
89+
attributes:
90+
label: Acknowledgment
91+
options:
92+
- label: This feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/Java/#tenets)
93+
required: true
94+
- 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/)
95+
required: false
96+
- type: markdown
97+
attributes:
98+
value: |
99+
---
100+
101+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
102+
103+
Metadata information for admin purposes, please leave them empty.
104+
105+
* RFC PR:
106+
* Approved by: ''
107+
* Reviewed by: ''

‎.github/ISSUE_TEMPLATE/share_your_work.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ body:
5353
label: Acknowledgment
5454
options:
5555
- 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)
56-
required: true
56+
required: true

‎.github/ISSUE_TEMPLATE/support_powertools.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Support Powertools for AWS Lambda (Java) (become a reference)
22
description: Add your organization's name or logo to the Powertools for AWS Lambda (Java) documentation
33
title: "[Support Powertools for AWS Lambda (Java)]: <your organization name>"
4-
labels: ["customer_reference"]
4+
labels: ["customer-reference"]
55
body:
66
- type: markdown
77
attributes:
@@ -48,9 +48,9 @@ body:
4848
- type: checkboxes
4949
id: other_languages
5050
attributes:
51-
label: Also using other Powertools for AWS Lambda (Java) languages?
51+
label: Also using other Powertools for AWS Lambda languages?
5252
options:
53-
- label: Python
53+
- label: Java
5454
required: false
5555
- label: TypeScript
5656
required: false
@@ -59,6 +59,6 @@ body:
5959
- type: markdown
6060
attributes:
6161
value: |
62-
*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.*
62+
*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.*
6363
6464
*You can opt-out at any time by commenting or reopening this issue.*

0 commit comments

Comments
 (0)