From cc9c9aa446346602a33c5ec0afda3ed1bb033b2a Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Thu, 25 Apr 2024 12:02:20 +0200 Subject: [PATCH 1/2] chore(maintenance): revamp PR & issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 14 ++--- .../documentation_improvements.yml | 1 - .github/ISSUE_TEMPLATE/maintenance.yml | 3 ++ .github/ISSUE_TEMPLATE/rfc.yml | 6 +++ .github/PULL_REQUEST_TEMPLATE.md | 52 ++++++------------- 5 files changed, 31 insertions(+), 45 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 10b58bde2c..063ccc76ab 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 @@ -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 @@ -77,8 +77,8 @@ body: attributes: label: Packaging format used options: - - Lambda Layers - npm + - Lambda Layers multiple: true validations: required: true diff --git a/.github/ISSUE_TEMPLATE/documentation_improvements.yml b/.github/ISSUE_TEMPLATE/documentation_improvements.yml index a8da1cfd40..7f86de4433 100644 --- a/.github/ISSUE_TEMPLATE/documentation_improvements.yml +++ b/.github/ISSUE_TEMPLATE/documentation_improvements.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml index 70434fb5af..6e9a70145c 100644 --- a/.github/ISSUE_TEMPLATE/maintenance.yml +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -31,6 +31,9 @@ body: - Automation - Governance - Tests + - Batch + - Commons + - Event Handler - Tracer - Logger - Metrics diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml index cd4a084ef2..96b1a14871 100644 --- a/.github/ISSUE_TEMPLATE/rfc.yml +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -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 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b5a6252622..8b58b6a7bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,50 +1,28 @@ - +## Summary -## Description of your changes +### Changes - -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 - - **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 + --- 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. \ No newline at end of file +**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful. From 6453ced5b01e1f448cd096598cb33de413612694 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Thu, 25 Apr 2024 12:45:41 +0200 Subject: [PATCH 2/2] chore: remove duplicate line --- .github/ISSUE_TEMPLATE/maintenance.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml index 6e9a70145c..026e6b050e 100644 --- a/.github/ISSUE_TEMPLATE/maintenance.yml +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -31,9 +31,9 @@ body: - Automation - Governance - Tests - - Batch - Commons - Event Handler + - Parser - Tracer - Logger - Metrics @@ -42,7 +42,6 @@ body: - JMESPath - Batch Processing - Validation - - Parser - Other - type: textarea id: suggestion