Add RFC template #4236

ericclemmons · 2019-10-22T18:22:50Z

As I was working on #4235, I would've benefited from a template based on prior RFCs:

(There are others, but they didn't follow a common format)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov · 2019-10-22T18:32:19Z

Codecov Report

Merging #4236 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4236   +/-   ##
=======================================
  Coverage   76.24%   76.24%           
=======================================
  Files         174      174           
  Lines        9619     9619           
  Branches     1964     1906   -58     
=======================================
  Hits         7334     7334           
- Misses       2140     2148    +8     
+ Partials      145      137    -8

Impacted Files	Coverage Δ
packages/core/src/OAuthHelper/GoogleOAuth.ts	`31.25% <0%> (ø)`	⬆️
...ackages/pubsub/src/Providers/AWSAppSyncProvider.ts	`66.66% <0%> (ø)`	⬆️
...pubsub/src/Providers/AWSAppSyncRealTimeProvider.ts	`18.64% <0%> (ø)`	⬆️
...rc/Providers/AmazonAIConvertPredictionsProvider.ts	`61.23% <0%> (ø)`	⬆️
packages/xr/src/Providers/SumerianProvider.ts	`47.55% <0%> (ø)`	⬆️
packages/core/src/OAuthHelper/FacebookOAuth.ts	`34.09% <0%> (ø)`	⬆️
packages/auth/src/OAuth/OAuth.ts	`48.48% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa8a01e...f663839. Read the comment docs.

ericclemmons

The current format is based on existing RFCs, but there are some beneficial components that we can borrow from https://github.com/reactjs/rfcs/blob/master/0000-template.md.

Drawbacks – Helpful for determining what is outside of scope or maintainability, as well as downstream impacts.
Detailed Design – Should be enough for someone to implement based off of, including corner-cases & exceptions where the proposal wouldn't apply.
Alternatives – What can meet the needs today, or in the future if the proposal is not accepted.

ashika01 · 2019-10-25T15:11:11Z

Love this @ericclemmons. 🎉
Just couple of thoughts:

I think in the Proposed Solution bit, we should have a high level architecture and the detailed design and its sample implementation or at least enough context / sample for anyone with familiarity to implement this.
Also we need to add a section to discuss pros and cons for the solution, compare and contrast the existing solution and solution's comparison with industry practices (not sure how to name this section).

ericclemmons · 2019-10-28T16:52:38Z

You're spot-on, @ashika01. I'll incorporate your feedback.

Whether it's an RFC or task, I'm a big fan of laying out the game-plan for anyone to execute. It's more effort upfront, but resolving that ambiguity early can make the difference in even needing the feature or not 🤞

https://github.com/reactjs/rfcs/blob/master/0000-template.md

.github/ISSUE_TEMPLATE/rfc.md

ashika01

Looks great. Just left a suggestion. But I think this is a great start. 🎉 🏅

Amplifiyer

This is great! Ship it!

.github/ISSUE_TEMPLATE/rfc.md

sammartinez

Overall, this is great! One callout that is critical for this PR. I just want to see about adding a note that makes it clear if any of the pieces of the structure is missing, we will close the RFC and ask the customer to open a feature request

.github/ISSUE_TEMPLATE/rfc.md

sammartinez · 2019-11-12T17:38:49Z

Overall, this is great! One callout that is critical for this PR. I just want to see about adding a note that makes it clear if any of the pieces of the structure is missing, we will close the RFC and ask the customer to open a feature request

LGTM. Just want to make sure we have the note about, "If we do not have all sections filled out, this RFC will be closed in favor of a feature request" Or something to that nature.

ericclemmons · 2019-11-14T19:34:12Z

The wording could come across a bit harsh. I think the best thing could be to clarify the difference between this & https://github.com/ericclemmons/amplify-js/blob/github-rfc-template/.github/ISSUE_TEMPLATE/feature_request.md, so that users can make the correct choice.

Honestly, the RFC template seems like the feature request template on steroids, but what I appreciate about the feature request is that it has a low bar for "I wish Amplify did X because of Y". (RFCs generally have a higher bar for larger, impactful changes, and is closer to what we would write for internal review).

What are your thoughts on solving the distinction issue on https://github.com/aws-amplify/amplify-js/issues/new/choose?

ashika01 · 2019-11-14T19:38:55Z

@ericclemmons: @sammartinez and I talked briefly about this. I think we should merge ur template for now and encourage people to submit RFC and mentor to write better RFC. We will have a WIKI page on life cycle of RFC and Acceptance Criteria.

.github/ISSUE_TEMPLATE/rfc.md

sammartinez · 2019-11-14T22:27:53Z

The wording could come across a bit harsh. I think the best thing could be to clarify the difference between this & https://github.com/ericclemmons/amplify-js/blob/github-rfc-template/.github/ISSUE_TEMPLATE/feature_request.md, so that users can make the correct choice.

Honestly, the RFC template seems like the feature request template on steroids, but what I appreciate about the feature request is that it has a low bar for "I wish Amplify did X because of Y". (RFCs generally have a higher bar for larger, impactful changes, and is closer to what we would write for internal review).

What are your thoughts on solving the distinction issue on https://github.com/aws-amplify/amplify-js/issues/new/choose?

Understood and part of it is customers may end up just removing the RFC template in general for a feature request tag. Im fine to get this in.

sammartinez

LGTM 🌮

ericclemmons · 2019-11-14T23:31:13Z

Thanks for the input everyone! Let's see how this works out in the wild and adjust from there.

In the meantime, this should help us have thorough RFCs in the open for customers to help provide feedback on. 🙏

github-actions · 2021-06-11T23:05:54Z

This pull request has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels or Discussions for those types of questions.

Add RFC template

416a78b

ericclemmons added feature-request Request a new feature Tooling Related to Tooling labels Oct 22, 2019

ericclemmons requested a review from mlabieniec as a code owner October 22, 2019 18:22

ericclemmons commented Oct 22, 2019

View reviewed changes

Update RFC with Detailed Design & Drawbacks

03456a7

https://github.com/reactjs/rfcs/blob/master/0000-template.md

ericclemmons requested review from ashika01 and sammartinez November 6, 2019 23:19

ericclemmons self-assigned this Nov 6, 2019

ashika01 reviewed Nov 7, 2019

View reviewed changes

.github/ISSUE_TEMPLATE/rfc.md Outdated Show resolved Hide resolved

ashika01 approved these changes Nov 7, 2019

View reviewed changes

Move Basic Example after Motivation

514f014

Amplifiyer approved these changes Nov 7, 2019

View reviewed changes

.github/ISSUE_TEMPLATE/rfc.md Outdated Show resolved Hide resolved

Merge branch 'master' into github-rfc-template

6cb616e

sammartinez suggested changes Nov 8, 2019

View reviewed changes

.github/ISSUE_TEMPLATE/rfc.md Outdated Show resolved Hide resolved

Remove HTML comments

af52b07

ericclemmons requested a review from sammartinez November 8, 2019 21:41

ericclemmons and others added 2 commits November 11, 2019 10:36

"of" should be "if"

4df8e9a

Merge branch 'master' into github-rfc-template

b0d4765

Merge branch 'master' into github-rfc-template

7034033

Merge branch 'master' into github-rfc-template

f866eb7

haverchuck reviewed Nov 14, 2019

View reviewed changes

.github/ISSUE_TEMPLATE/rfc.md Show resolved Hide resolved

sammartinez approved these changes Nov 14, 2019

View reviewed changes

Fix --- usage

48da0c7

ericclemmons added 3 commits December 6, 2019 10:27

Merge branch 'master' into github-rfc-template

fd576ba

Merge branch 'master' into github-rfc-template

7b200c7

Merge branch 'master' into github-rfc-template

f663839

ericclemmons merged commit eaff2d1 into aws-amplify:master Dec 20, 2019

ericclemmons deleted the github-rfc-template branch December 20, 2019 19:47

github-actions bot locked as resolved and limited conversation to collaborators Jun 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RFC template #4236

Add RFC template #4236

ericclemmons commented Oct 22, 2019

codecov bot commented Oct 22, 2019 •

edited

Loading

ericclemmons left a comment

ashika01 commented Oct 25, 2019

ericclemmons commented Oct 28, 2019

ashika01 left a comment •

edited

Loading

Amplifiyer left a comment

sammartinez left a comment

sammartinez commented Nov 12, 2019 •

edited

Loading

ericclemmons commented Nov 14, 2019 •

edited

Loading

ashika01 commented Nov 14, 2019

sammartinez commented Nov 14, 2019

sammartinez left a comment

ericclemmons commented Nov 14, 2019

github-actions bot commented Jun 11, 2021

Add RFC template #4236

Add RFC template #4236

Conversation

ericclemmons commented Oct 22, 2019

codecov bot commented Oct 22, 2019 • edited Loading

Codecov Report

ericclemmons left a comment

Choose a reason for hiding this comment

ashika01 commented Oct 25, 2019

ericclemmons commented Oct 28, 2019

ashika01 left a comment • edited Loading

Choose a reason for hiding this comment

Amplifiyer left a comment

Choose a reason for hiding this comment

sammartinez left a comment

Choose a reason for hiding this comment

sammartinez commented Nov 12, 2019 • edited Loading

ericclemmons commented Nov 14, 2019 • edited Loading

ashika01 commented Nov 14, 2019

sammartinez commented Nov 14, 2019

sammartinez left a comment

Choose a reason for hiding this comment

ericclemmons commented Nov 14, 2019

github-actions bot commented Jun 11, 2021

codecov bot commented Oct 22, 2019 •

edited

Loading

ashika01 left a comment •

edited

Loading

sammartinez commented Nov 12, 2019 •

edited

Loading

ericclemmons commented Nov 14, 2019 •

edited

Loading