|
1 | | ---- |
2 | | -name: RFC |
3 | | -about: Feature design and proposals |
4 | | -title: 'RFC: ' |
5 | | -labels: RFC, triage |
6 | | -assignees: '' |
7 | | - |
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://docs.powertools.aws.dev/lambda-java/#tenets): (Yes/no) |
16 | | - |
17 | | -## Summary |
18 | | -[summary]: #summary |
19 | | - |
20 | | -> One paragraph explanation of the feature. |
21 | | -
|
22 | | -## Motivation |
23 | | -[motivation]: #motivation |
24 | | - |
25 | | -> Why are we doing this? What use cases does it support? What is the expected outcome? |
26 | | -
|
27 | | -## Proposal |
28 | | -[proposal]: #proposal |
29 | | - |
30 | | -> This is the bulk of the RFC. |
31 | | -
|
32 | | -> Explain the design in enough detail for somebody familiar with Powertools for AWS Lambda (Java) to understand it, and for somebody familiar with the implementation to implement it. |
33 | | -
|
34 | | -> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here. |
35 | | -
|
36 | | -## Drawbacks |
37 | | -[drawbacks]: #drawbacks |
38 | | - |
39 | | -> Why should we *not* do this? |
40 | | -
|
41 | | -> Do we need additional dependencies? Impact performance/package size? |
42 | | -
|
43 | | -## Rationale and alternatives |
44 | | -[rationale-and-alternatives]: #rationale-and-alternatives |
45 | | - |
46 | | -* **What other designs have been considered? Why not them?** |
47 | | -* **What is the impact of not doing this?** |
48 | | - |
49 | | -## Unresolved questions |
50 | | -[unresolved-questions]: #unresolved-questions |
51 | | - |
52 | | -> Optional, stash area for topics that need further development e.g. TBD |
| 1 | +name: Request for Comments (RFC) |
| 2 | +description: Feature design and detailed proposals |
| 3 | +title: "RFC: TITLE" |
| 4 | +labels: ["RFC", "triage"] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + Thank you for submitting a RFC. Please add as many details as possible to help further enrich this design. |
| 10 | + - type: input |
| 11 | + id: relation |
| 12 | + attributes: |
| 13 | + label: Is this related to an existing feature request or issue? |
| 14 | + description: Please share a link, if applicable |
| 15 | + - type: dropdown |
| 16 | + id: area |
| 17 | + attributes: |
| 18 | + label: Which Powertools for AWS Lambda (Java) utility does this relate to? |
| 19 | + options: |
| 20 | + - Tracer |
| 21 | + - Logger |
| 22 | + - Metrics |
| 23 | + - Middleware factory |
| 24 | + - Parameters |
| 25 | + - Batch processing |
| 26 | + - Typing |
| 27 | + - Validation |
| 28 | + - Event Source Data Classes |
| 29 | + - Parser |
| 30 | + - Idempotency |
| 31 | + - Feature flags |
| 32 | + - JMESPath functions |
| 33 | + - Other |
| 34 | + validations: |
| 35 | + required: true |
| 36 | + - type: textarea |
| 37 | + id: summary |
| 38 | + attributes: |
| 39 | + label: Summary |
| 40 | + description: Please provide an overview in one or two paragraphs |
| 41 | + validations: |
| 42 | + required: true |
| 43 | + - type: textarea |
| 44 | + id: problem |
| 45 | + attributes: |
| 46 | + label: Use case |
| 47 | + description: Please share the use case and motivation behind this proposal |
| 48 | + validations: |
| 49 | + required: true |
| 50 | + - type: textarea |
| 51 | + id: proposal |
| 52 | + attributes: |
| 53 | + label: Proposal |
| 54 | + description: Please explain the design in detail, so anyone familiar with the project could implement it |
| 55 | + placeholder: What the user experience looks like before and after this design? |
| 56 | + validations: |
| 57 | + required: true |
| 58 | + - type: textarea |
| 59 | + id: scope |
| 60 | + attributes: |
| 61 | + label: Out of scope |
| 62 | + description: Please explain what should be considered out of scope in your proposal |
| 63 | + validations: |
| 64 | + required: true |
| 65 | + - type: textarea |
| 66 | + id: challenges |
| 67 | + attributes: |
| 68 | + label: Potential challenges |
| 69 | + description: Nothing is perfect. Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them |
| 70 | + validations: |
| 71 | + required: true |
| 72 | + - type: textarea |
| 73 | + id: integrations |
| 74 | + attributes: |
| 75 | + label: Dependencies and Integrations |
| 76 | + description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available |
| 77 | + validations: |
| 78 | + required: false |
| 79 | + - type: textarea |
| 80 | + id: alternatives |
| 81 | + attributes: |
| 82 | + label: Alternative solutions |
| 83 | + description: Please describe what alternative solutions to this use case, if any |
| 84 | + render: markdown |
| 85 | + validations: |
| 86 | + required: false |
| 87 | + - type: checkboxes |
| 88 | + id: acknowledgment |
| 89 | + attributes: |
| 90 | + label: Acknowledgment |
| 91 | + options: |
| 92 | + - label: This feature request meets [Powertools for AWS Lambda (Java) Tenets](https://docs.powertools.aws.dev/lambda/Java/#tenets) |
| 93 | + required: true |
| 94 | + - label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [TypeScript](https://github.com/aws-powertools/powertools-lambda-typescript/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/) |
| 95 | + required: false |
| 96 | + - type: markdown |
| 97 | + attributes: |
| 98 | + value: | |
| 99 | + --- |
| 100 | + |
| 101 | + **Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful. |
| 102 | + |
| 103 | + Metadata information for admin purposes, please leave them empty. |
| 104 | + |
| 105 | + * RFC PR: |
| 106 | + * Approved by: '' |
| 107 | + * Reviewed by: '' |
0 commit comments