Skip to content

Commit 27dbb88

Browse files
authored
feat: add RFC template for proposals
1 parent dd4d137 commit 27dbb88

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

.github/ISSUE_TEMPLATE/feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: triage, feature-request
5+
labels: feature-request, triage
66
assignees: ''
77

88
---

.github/ISSUE_TEMPLATE/rfc.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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://awslabs.github.io/aws-lambda-powertools-python/#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 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

0 commit comments

Comments
 (0)