Skip to content

Commit 936d5e9

Browse files
dreamorosiam29d
andauthored
chore(maintenance): revamp PR & issue templates (#2435)
* chore(maintenance): revamp PR & issue templates * chore: remove duplicate line --------- Co-authored-by: Alexander Schueren <[email protected]>
1 parent 3c294d3 commit 936d5e9

File tree

5 files changed

+31
-46
lines changed

5 files changed

+31
-46
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ body:
1111
1212
Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
1313
- type: textarea
14-
id: expected_behaviour
14+
id: expected_behavior
1515
attributes:
16-
label: Expected Behaviour
17-
description: Please share details on the behaviour you expected
16+
label: Expected Behavior
17+
description: Please share details on the behavior you expected
1818
validations:
1919
required: true
2020
- type: textarea
21-
id: current_behaviour
21+
id: current_behavior
2222
attributes:
23-
label: Current Behaviour
23+
label: Current Behavior
2424
description: Please share details on the current issue
2525
validations:
2626
required: true
@@ -58,7 +58,7 @@ body:
5858
id: version
5959
attributes:
6060
label: Powertools for AWS Lambda (TypeScript) version
61-
placeholder: "latest, 1.3.0"
61+
placeholder: "latest, 2.1.0"
6262
value: latest
6363
validations:
6464
required: true
@@ -77,8 +77,8 @@ body:
7777
attributes:
7878
label: Packaging format used
7979
options:
80-
- Lambda Layers
8180
- npm
81+
- Lambda Layers
8282
multiple: true
8383
validations:
8484
required: true

.github/ISSUE_TEMPLATE/documentation_improvements.yml

-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ body:
2727
attributes:
2828
label: How can we improve?
2929
description: Please share your thoughts on how we can improve this experience
30-
render: Markdown
3130
validations:
3231
required: true
3332
- type: textarea

.github/ISSUE_TEMPLATE/maintenance.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ body:
3131
- Automation
3232
- Governance
3333
- Tests
34+
- Commons
35+
- Event Handler
36+
- Parser
3437
- Tracer
3538
- Logger
3639
- Metrics
@@ -39,7 +42,6 @@ body:
3942
- JMESPath
4043
- Batch Processing
4144
- Validation
42-
- Parser
4345
- Other
4446
- type: textarea
4547
id: suggestion

.github/ISSUE_TEMPLATE/rfc.yml

+6
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ body:
1818
attributes:
1919
label: Which Powertools for AWS Lambda (TypeScript) utility does this relate to?
2020
options:
21+
- Automation
22+
- Governance
23+
- Tests
24+
- Batch
25+
- Commons
26+
- Event Handler
2127
- Tracer
2228
- Logger
2329
- Metrics

.github/PULL_REQUEST_TEMPLATE.md

+15-37
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,28 @@
1-
<!---
2-
Instructions:
3-
1. Make sure you follow our Contributing Guidelines: https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md
4-
2. Please follow the template, and do not remove any section/item. If something is not applicable leave it empty, but leave it in the PR.
5-
3. -->
1+
## Summary
62

7-
## Description of your changes
3+
### Changes
84

9-
<!---
10-
Include here a summary of the change.
5+
> Please provide a summary of what's being changed
116
12-
Please include also relevant motivation and context.
7+
<!-- What is this PR solving? Write a clear description or reference the issue(s) it addresses. -->
138

14-
Add any applicable code snippets, links, screenshots, or other resources
15-
that can help us verify your changes.
16-
-->
9+
> Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed
1710
18-
### Related issues, RFCs
19-
20-
<!---
21-
Add here the number (i.e. #42) to the Github Issue or RFC that is related to this PR.
22-
23-
Don't include any other text, otherwise the Github Issue will not be detected.
24-
25-
Note: If no issue is present the PR might get blocked and not be reviewed.
26-
-->
2711
**Issue number:**
2812

29-
## Checklist
30-
31-
- [ ] [My changes meet the tenets criteria](https://docs.powertools.aws.dev/lambda/typescript/#tenets)
32-
- [ ] I have performed a *self-review* of my own code
33-
- [ ] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
34-
- [ ] I have made corresponding changes to the *documentation*
35-
- [ ] My changes generate *no new warnings*
36-
- [ ] I have *added tests* that prove my change is effective and works
37-
- [ ] The PR title follows the [conventional commit semantics](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2)
38-
39-
### Breaking change checklist
40-
41-
***Is it a breaking change?:*** NO
13+
<!-------
14+
Before creating the pull request, please make sure you do the following:
4215
43-
- [ ] I have documented the migration process
44-
- [ ] I have added, implemented necessary warnings (if it can live side by side)
16+
- Read the Contributing Guidelines at https://github.com/aws-powertools/powertools-lambda-typescript/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/typescript/latest/#tenets
19+
- Add a PR title that follows the conventional commit semantics - https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2
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+
------->
4523

4624
---
4725

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

50-
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
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)