Skip to content

chore(maintenance): revamp PR & issue templates #2435

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

Merged
merged 4 commits into from
Apr 25, 2024
Merged
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
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ body:

Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
- type: textarea
id: expected_behaviour
id: expected_behavior
attributes:
label: Expected Behaviour
description: Please share details on the behaviour you expected
label: Expected Behavior
description: Please share details on the behavior you expected
validations:
required: true
- type: textarea
id: current_behaviour
id: current_behavior
attributes:
label: Current Behaviour
label: Current Behavior
description: Please share details on the current issue
validations:
required: true
Expand Down Expand Up @@ -58,7 +58,7 @@ body:
id: version
attributes:
label: Powertools for AWS Lambda (TypeScript) version
placeholder: "latest, 1.3.0"
placeholder: "latest, 2.1.0"
value: latest
validations:
required: true
Expand All @@ -77,8 +77,8 @@ body:
attributes:
label: Packaging format used
options:
- Lambda Layers
- npm
- Lambda Layers
multiple: true
validations:
required: true
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/documentation_improvements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ body:
attributes:
label: How can we improve?
description: Please share your thoughts on how we can improve this experience
render: Markdown
validations:
required: true
- type: textarea
Expand Down
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ body:
- Automation
- Governance
- Tests
- Commons
- Event Handler
- Parser
- Tracer
- Logger
- Metrics
Expand All @@ -39,7 +42,6 @@ body:
- JMESPath
- Batch Processing
- Validation
- Parser
- Other
- type: textarea
id: suggestion
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ body:
attributes:
label: Which Powertools for AWS Lambda (TypeScript) utility does this relate to?
options:
- Automation
- Governance
- Tests
- Batch
- Commons
- Event Handler
- Tracer
- Logger
- Metrics
Expand Down
52 changes: 15 additions & 37 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,28 @@
<!---
Instructions:
1. Make sure you follow our Contributing Guidelines: https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md
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.
3. -->
## Summary

## Description of your changes
### Changes

<!---
Include here a summary of the change.
> Please provide a summary of what's being changed

Please include also relevant motivation and context.
<!-- What is this PR solving? Write a clear description or reference the issue(s) it addresses. -->

Add any applicable code snippets, links, screenshots, or other resources
that can help us verify your changes.
-->
> Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

### Related issues, RFCs

<!---
Add here the number (i.e. #42) to the Github Issue or RFC that is related to this PR.

Don't include any other text, otherwise the Github Issue will not be detected.

Note: If no issue is present the PR might get blocked and not be reviewed.
-->
**Issue number:**

## Checklist

- [ ] [My changes meet the tenets criteria](https://docs.powertools.aws.dev/lambda/typescript/#tenets)
- [ ] I have performed a *self-review* of my own code
- [ ] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
- [ ] I have made corresponding changes to the *documentation*
- [ ] My changes generate *no new warnings*
- [ ] I have *added tests* that prove my change is effective and works
- [ ] The PR title follows the [conventional commit semantics](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2)

### Breaking change checklist

***Is it a breaking change?:*** NO
<!-------
Before creating the pull request, please make sure you do the following:

- [ ] I have documented the migration process
- [ ] I have added, implemented necessary warnings (if it can live side by side)
- Read the Contributing Guidelines at https://github.com/aws-powertools/powertools-lambda-typescript/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/typescript/latest/#tenets
- Add a PR title that follows the conventional commit semantics - https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2
- 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
------->

---

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