Skip to content

improv: github issues template, RFC added #572

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 3 commits into from
Feb 23, 2022
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Documentation improvement
about: Suggest a documentation update, improvement
title: "(module name): short issue description"
title: "Documentation (module name): short issue description"
labels: documentation
---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Feature request
about: Suggest an idea for this project
title: "(module name): short issue description"
title: "Feature (module name): short issue description"
labels: feature-request, triage
---

Expand Down
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/RFC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: RFC
about: Feature design and proposals
title: 'RFC (module name): short issue 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

<!--- One paragraph explanation of the feature. -->

## Motivation
[motivation]: #motivation
<!--- Why are we doing this? What use cases does it support? What is the expected outcome? -->


## Proposal
[proposal]: #proposal

<!--- This is the bulk of the RFC. -->
<!--- Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it. -->


<!--- If this feature should be available in other runtimes (e.g. Java, Typescript), how would this look like to ensure consistency? -->


## User Experience

<!--- How would customers use it? -->


<!--- Any configuration or corner cases you'd expect? -->


<!--- Demonstration of before and after on how the experience will be better -->


## Drawbacks
[drawbacks]: #drawbacks

<!--- Why should we *not* do this? -->


<!--- Do we need additional dependencies? Impact performance/package size? -->


## Rationale and alternatives
[rationale-and-alternatives]: #rationale-and-alternatives

<!--- What other designs have been considered? Why not them? -->


<!--- What is the impact of not doing this? -->


## Unresolved questions
[unresolved-questions]: #unresolved-questions

<!--- Optional, stash area for topics that need further development e.g. TBD -->