|
| 1 | +--- |
| 2 | +name: RFC |
| 3 | +about: Feature design and proposals |
| 4 | +title: 'RFC (module name): short issue description' |
| 5 | +labels: RFC, triage |
| 6 | +assignees: '' |
| 7 | +approved by: '' |
| 8 | +--- |
| 9 | + |
| 10 | +## Key information |
| 11 | + |
| 12 | +* RFC PR: (leave this empty) |
| 13 | +* Related issue(s), if known: |
| 14 | +* Area: (i.e. Tracer, Metrics, Logger, etc.) |
| 15 | +* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets): (Yes/no) |
| 16 | +* Approved by: '' |
| 17 | +* Reviewed by: '' |
| 18 | + |
| 19 | +## Summary |
| 20 | +[summary]: #summary |
| 21 | + |
| 22 | +<!--- One paragraph explanation of the feature. --> |
| 23 | + |
| 24 | +## Motivation |
| 25 | +[motivation]: #motivation |
| 26 | +<!--- Why are we doing this? What use cases does it support? What is the expected outcome? --> |
| 27 | + |
| 28 | + |
| 29 | +## Proposal |
| 30 | +[proposal]: #proposal |
| 31 | + |
| 32 | +<!--- This is the bulk of the RFC. --> |
| 33 | +<!--- Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it. --> |
| 34 | + |
| 35 | + |
| 36 | +<!--- If this feature should be available in other runtimes (e.g. Java, Typescript), how would this look like to ensure consistency? --> |
| 37 | + |
| 38 | + |
| 39 | +## User Experience |
| 40 | + |
| 41 | +<!--- How would customers use it? --> |
| 42 | + |
| 43 | + |
| 44 | +<!--- Any configuration or corner cases you'd expect? --> |
| 45 | + |
| 46 | + |
| 47 | +<!--- Demonstration of before and after on how the experience will be better --> |
| 48 | + |
| 49 | + |
| 50 | +## Drawbacks |
| 51 | +[drawbacks]: #drawbacks |
| 52 | + |
| 53 | +<!--- Why should we *not* do this? --> |
| 54 | + |
| 55 | + |
| 56 | +<!--- Do we need additional dependencies? Impact performance/package size? --> |
| 57 | + |
| 58 | + |
| 59 | +## Rationale and alternatives |
| 60 | +[rationale-and-alternatives]: #rationale-and-alternatives |
| 61 | + |
| 62 | +<!--- What other designs have been considered? Why not them? --> |
| 63 | + |
| 64 | + |
| 65 | +<!--- What is the impact of not doing this? --> |
| 66 | + |
| 67 | + |
| 68 | +## Unresolved questions |
| 69 | +[unresolved-questions]: #unresolved-questions |
| 70 | + |
| 71 | +<!--- Optional, stash area for topics that need further development e.g. TBD --> |
0 commit comments