From ba1b47273ceedd93dfea41589a6c2e861922ed78 Mon Sep 17 00:00:00 2001 From: Sara Gerion Date: Wed, 23 Feb 2022 10:43:15 +0100 Subject: [PATCH 1/3] improv: github issues template, RFC added --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 2 +- .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md | 2 +- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 2 +- .github/ISSUE_TEMPLATE/RFC.md | 71 +++++++++++++++++++++++ 4 files changed, 74 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/RFC.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index a68fccc584..9b40228442 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: "(module name): short issue description" +title: "Bug (module name): short issue description" labels: bug, triage --- diff --git a/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md b/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md index 5cce104f88..2a518f7ea4 100644 --- a/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md +++ b/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md @@ -1,7 +1,7 @@ --- name: Documentation improvement about: Suggest a documentation update, improvement -title: "(module name): short issue description" +title: "Doc improvement (module name): short issue description" labels: documentation --- diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index 04e23eae87..5f06ed75fa 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -title: "(module name): short issue description" +title: "Feature request (module name): short issue description" labels: feature-request, triage --- diff --git a/.github/ISSUE_TEMPLATE/RFC.md b/.github/ISSUE_TEMPLATE/RFC.md new file mode 100644 index 0000000000..1c20908b5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RFC.md @@ -0,0 +1,71 @@ +--- +name: RFC +about: Feature design and proposals +title: 'RFC (module name): short description' +labels: RFC, triage +assignees: '' +approved by: '' +--- + +## Key information + +* RFC PR: (leave this empty) +* Related issue(s), if known: +* Area: (i.e. Tracer, Metrics, Logger, etc.) +* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets): (Yes/no) +* Approved by: '' +* Reviewed by: '' + +## Summary +[summary]: #summary + + + +## Motivation +[motivation]: #motivation + + + +## Proposal +[proposal]: #proposal + + + + + + + + +## User Experience + + + + + + + + + + +## Drawbacks +[drawbacks]: #drawbacks + + + + + + + +## Rationale and alternatives +[rationale-and-alternatives]: #rationale-and-alternatives + + + + + + + +## Unresolved questions +[unresolved-questions]: #unresolved-questions + + \ No newline at end of file From 821bb26f9ee91abc6a357a3918b17efab533fb8e Mon Sep 17 00:00:00 2001 From: Sara Gerion Date: Wed, 23 Feb 2022 10:46:58 +0100 Subject: [PATCH 2/3] fix: RFC title --- .github/ISSUE_TEMPLATE/RFC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RFC.md b/.github/ISSUE_TEMPLATE/RFC.md index 1c20908b5a..d5ee8d6d3a 100644 --- a/.github/ISSUE_TEMPLATE/RFC.md +++ b/.github/ISSUE_TEMPLATE/RFC.md @@ -1,7 +1,7 @@ --- name: RFC about: Feature design and proposals -title: 'RFC (module name): short description' +title: 'RFC (module name): short issue description' labels: RFC, triage assignees: '' approved by: '' From 78f86730706ed7c1c008043a4def558d61979233 Mon Sep 17 00:00:00 2001 From: Sara Gerion Date: Wed, 23 Feb 2022 10:49:29 +0100 Subject: [PATCH 3/3] improv: github issues titles consistency --- .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md | 2 +- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md b/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md index 2a518f7ea4..89144bac46 100644 --- a/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md +++ b/.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md @@ -1,7 +1,7 @@ --- name: Documentation improvement about: Suggest a documentation update, improvement -title: "Doc improvement (module name): short issue description" +title: "Documentation (module name): short issue description" labels: documentation --- diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index 5f06ed75fa..99af78e849 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -title: "Feature request (module name): short issue description" +title: "Feature (module name): short issue description" labels: feature-request, triage ---