Skip to content
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

Add RFC template #4236

Merged
merged 13 commits into from
Dec 20, 2019
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.md
Original file line number Diff line number Diff line change
@@ -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: ''
ericclemmons marked this conversation as resolved.
Show resolved Hide resolved

---

_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/