Add RFC template (aws-amplify#4236)

* Add RFC template * Update RFC with Detailed Design & Drawbacks https://github.com/reactjs/rfcs/blob/master/0000-template.md * Move Basic Example after Motivation * Remove HTML comments * "of" should be "if" * Fix --- usage Co-authored-by: Sam Martinez <[email protected]>
kgpasta · Dec 20, 2019 · eaff2d1 · eaff2d1
1 parent aa8a01e
commit eaff2d1
Showing 1 changed file with 48 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/rfc.md b/.github/ISSUE_TEMPLATE/rfc.md
@@ -0,0 +1,48 @@
+---
+name: Request For Comments (RFC)
+about: Gather community feedback regarding a proposed change to the library
+title: 'RFC: PROPOSAL HEADLINE'
+labels: feature-request
+assignees: ''
+
+---
+
+_This issue is a Request For Comments (RFC). It is intended to elicit community feedback regarding a proposed change to the library. Please feel free to post comments or questions here._
+
+## Summary
+
+In one or two sentences, why should this change exist?
+
+## Motivation
+
+Why is this RFC needed? What will happen if accepted? And what would happen if it *isn't* accepted?
+
+## Basic Example
+
+If the RFC involves a new or changed API, include a basic code example. (Omit if not applicable)
+
+## Detailed Design
+
+Provide enough detail on *how* this should be implemented such that someone other than yourself could build it.
+Include examples of how the implementation is used
+
+## Drawbacks
+
+- Is this a breaking change? Days/Weeks/Months to implement? Will it require extensive documentation & examples?
+
+## Adoption Strategy
+
+- What supporting efforts will be needed (e.g. documentation, tests, tutorials, public outreach, etc.)?
+
+## Related Issues
+
+Add GitHub issue numbers/URLs that informed or would be impacted by this proposal.
+
+- #1234
+- https://github.com/aws-amplify/amplify-js/issues/1234
+
+## References
+
+List articles, resources, prior art, and inspiration for this proposal.
+
+- http://stackoverflow.com/