Skip to content

Commit ffd88b9

Browse files
dreamorosiphipag
andauthored
chore: update issue, PR, and discussion templates (#1915)
* chore: update issue & discussion templates * chore: update PR template * Update .github/PULL_REQUEST_TEMPLATE.md * Update .github/DISCUSSION_TEMPLATE/rfcs.yml * Update .github/DISCUSSION_TEMPLATE/rfcs.yml --------- Co-authored-by: Philipp Page <[email protected]>
1 parent 8b6d484 commit ffd88b9

File tree

8 files changed

+94
-55
lines changed

8 files changed

+94
-55
lines changed

.github/ISSUE_TEMPLATE/rfc.md renamed to .github/DISCUSSION_TEMPLATE/rfcs.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
name: Request for Comments (RFC)
2-
description: Feature design and detailed proposals
3-
title: "RFC: TITLE"
4-
labels: ["RFC", "triage"]
1+
title: "RFC: <Title>"
52
body:
63
- type: markdown
74
attributes:
@@ -15,21 +12,18 @@ body:
1512
- type: dropdown
1613
id: area
1714
attributes:
18-
label: Which Powertools for AWS Lambda (Java) utility does this relate to?
15+
label: Which area does this RFC relate to?
1916
options:
2017
- Tracer
2118
- Logger
2219
- Metrics
23-
- Middleware factory
2420
- Parameters
25-
- Batch processing
26-
- Typing
21+
- Large Messages
22+
- Batch Processing
2723
- Validation
28-
- Event Source Data Classes
29-
- Parser
3024
- Idempotency
31-
- Feature flags
32-
- JMESPath functions
25+
- Custom Resources
26+
- Serialization
3327
- Other
3428
validations:
3529
required: true
@@ -81,15 +75,15 @@ body:
8175
attributes:
8276
label: Alternative solutions
8377
description: Please describe what alternative solutions to this use case, if any
84-
render: markdown
78+
render: Markdown
8579
validations:
8680
required: false
8781
- type: checkboxes
8882
id: acknowledgment
8983
attributes:
9084
label: Acknowledgment
9185
options:
92-
- label: This feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/Java/#tenets)
86+
- label: This RFC meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/java/latest/#tenets)
9387
required: true
9488
- 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/)
9589
required: false
@@ -98,10 +92,16 @@ body:
9892
value: |
9993
---
10094
101-
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
95+
**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.
10296
10397
Metadata information for admin purposes, please leave them empty.
10498
10599
* RFC PR:
106100
* Approved by: ''
107-
* Reviewed by: ''
101+
* Reviewed by: ''
102+
- type: input
103+
id: notes
104+
attributes:
105+
label: Future readers
106+
description: Please not edit this field
107+
value: "Please react with 👍 and your use case to help us understand customer demand."

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Bug report
22
description: Report a reproducible bug to help us improve
33
title: "Bug: TITLE"
4+
type: "Bug"
45
labels: ["bug", "triage"]
56
body:
67
- type: markdown
@@ -49,7 +50,7 @@ body:
4950
id: version
5051
attributes:
5152
label: Powertools for AWS Lambda (Java) version
52-
placeholder: "latest, 1.19.0"
53+
placeholder: "latest, 2.0.1"
5354
value: latest
5455
validations:
5556
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
44
url: https://github.com/aws-powertools/powertools-lambda-java/discussions/new
5-
about: Ask a general question about Lambda Powertools
5+
about: Ask a general question about Powertools for AWS Lambda
6+
- name: Join Community Discord Server
7+
url: https://discord.gg/B8zZKbbyET
8+
about: "Check out the #java channel"

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature request
2+
description: Suggest an idea for Powertools for AWS Lambda
3+
title: "Feature request: TITLE"
4+
labels: ["feature-request", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to suggest an idea to the Powertools for AWS Lambda (Java) project.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Use case
14+
description: Please help us understand your use case or problem you're facing
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: suggestion
19+
attributes:
20+
label: Solution/User Experience
21+
description: Please share what a good solution would look like to this use case
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Alternative solutions
28+
description: Please describe what alternative solutions to this use case, if any
29+
render: Markdown
30+
validations:
31+
required: false
32+
- type: checkboxes
33+
id: acknowledgment
34+
attributes:
35+
label: Acknowledgment
36+
options:
37+
- label: This feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/java/latest/#tenets)
38+
required: true
39+
- 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/)
40+
required: false
41+
- type: markdown
42+
attributes:
43+
value: |
44+
---
45+
46+
**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.
47+
- type: input
48+
id: notes
49+
attributes:
50+
label: Future readers
51+
description: Please not edit this field
52+
value: "Please react with 👍 and your use case to help us understand customer demand."

.github/ISSUE_TEMPLATE/share_your_work.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: I Made This (showcase your work)
22
description: Share what you did with Powertools for AWS Lambda (Java) 💞💞. Blog post, workshops, presentation, sample apps, etc.
33
title: "[I Made This]: <TITLE>"
4-
labels: ["community-content"]
4+
labels: ["community-content", "triage"]
55
body:
66
- type: markdown
77
attributes:

.github/ISSUE_TEMPLATE/support_powertools.yml

Lines changed: 1 addition & 1 deletion
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", "triage"]
55
body:
66
- type: markdown
77
attributes:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
**Issue #, if available:**
1+
## Summary
22

3-
## Description of changes:
3+
### Changes
44

5-
<!--- One or two sentences as a summary of what's being changed -->
5+
> Please provide a summary of what's being changed
66
7-
**Checklist**
7+
<!-- What is this PR solving? Write a clear description or reference the issue(s) it addresses. -->
88

9-
<!--- Leave unchecked if your change doesn't seem to apply -->
9+
> Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed
1010
11-
* [ ] [Meet tenets criteria](https://docs.powertools.aws.dev/lambda-java/#tenets)
12-
* [ ] Update tests
13-
* [ ] Update docs
14-
* [ ] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0/)
11+
**Issue number:**
1512

16-
## Breaking change checklist
13+
<!-------
14+
Before creating the pull request, please make sure you do the following:
1715
18-
<!--- Ignore if it's not a breaking change -->
16+
- Read the Contributing Guidelines at https://github.com/aws-powertools/powertools-lambda-java/blob/main/CONTRIBUTING.md#sending-a-pull-request
17+
- 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
18+
- Check that the change meets the project's tenets https://docs.powertools.aws.dev/lambda/java/latest/#tenets
19+
- Add a PR title that follows the conventional commit semantics - https://www.conventionalcommits.org/en/v1.0.0/
20+
- If relevant, add tests that prove that the change is effective and works
21+
- Whenever relevant, make sure to comment functions/methods/types and make appropriate changes to the documentation
22+
------->
1923

20-
**RFC issue #**:
21-
22-
* [ ] Migration process documented
23-
* [ ] Implement warnings (if it can live side by side)
24+
---
2425

2526
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
27+
28+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

0 commit comments

Comments
 (0)