Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-Authored-By: Romain Marcadier-Muller <[email protected]>
Adds code of conduct and notice files.
  • Loading branch information
MrArnoldPalmer committed Dec 18, 2019
1 parent ac7aedc commit 27cdf4b
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 14 deletions.
4 changes: 2 additions & 2 deletions 0000-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Summary

Brief explanation of the feature.
Brief description of the feature.

# Motivation

Expand Down Expand Up @@ -63,7 +63,7 @@ this a breaking change? How can we assist in adoption?

# Future Possibilities

THing about what the natural extension and evolution of your proposal would be
Think about what the natural extension and evolution of your proposal would be
and how it would affect CDK as whole. Try to use this section as a tool to more
fully consider all possible interactions with the project and ecosystem in your
proposal. Also consider how this fits into the roadmap for the project.
Expand Down
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
[email protected] with any additional questions or comments.
2 changes: 2 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
AWS Cloud Development Kit (AWS CDK)
Copyright 2018-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AWS CDK RFCs - [Active RFC List](https://github.com/rust-lang/rfcs/pulls)
# AWS CDK RFCs - [Active RFC List](https://github.com/awslabs/aws-cdk-rfcs/pulls)

Many changes, including bug fixes and documentation improvements can be
implemented and reviewed via the normal GitHub pull request workflow.
Expand All @@ -15,13 +15,13 @@ consistent and controlled path for new features to enter the project.
## When to follow this process

You should consider using this process if you intend to make "substantial"
changes to [AWS CDK](), [JSII](), or related tools. Some examples that would
changes to [AWS CDK](https://github.com/aws/aws-cdk), [JSII](https://github.com/aws/jsii), or related tools. Some examples that would
benefit from an RFC are:

- Any change to existing APIs that would break existing code.
- The removal of existing features or public APIs.
- The introduction of new idiomatic usage or conventions, even if they
do not include code changes to React itself.
do not include code changes to CDK itself.

The RFC process is a great opportunity to get more eyeballs on your proposal
before it becomes a part of a released version of CDK. Quite often, even
Expand All @@ -33,7 +33,7 @@ feature as it is being designed, and incorporate important constraints into
the design while it's easier to change, before the design has been fully
implemented.

If you submit a pull request to implement a new feature without going through
If you submit a pull request to implement a new major feature without going through
the RFC process, it may be closed with a polite request to submit an RFC first.

Some changes do not require an RFC:
Expand All @@ -54,7 +54,7 @@ into CDK.
- Copy `0000-template.md` to `text/0000-my-feature.md` (where 'my-feature' is
descriptive. Don't assign an RFC number yet.
- Fill in the RFC. Put care into the details: **RFCs that do not present
convincing motiviation, demonstrate understanding of the impact of the design,
convincing motivation, demonstrate understanding of the impact of the design,
or are disingenuous about the drawbacks or alternatives tend to be
poorly-received**.
- Submit a pull request. As a pull request the RFC will receive design
Expand All @@ -69,17 +69,17 @@ into CDK.
with a comment and label on the RFCs pull request.
- An RFC can be modified based upon feedback from the team and community.
Significant modifications may trigger a new final comment period.
- An RFC may be rejecte4d by the team after public discussion has settled and
- An RFC may be rejected by the team after public discussion has settled and
comments have been made summarizing the rationale for rejection. A member of
the team should then close the RFCs associated pull request.
- An RFC may be accepted ad the close of its final comment period. A team
- An RFC may be accepted at the close of its final comment period. A team
member will merge the RFCs associated pull request, at which point the RFC
will become 'active'.

## The RFC life-cycle

Once an RFC becomes active, then authors may implement it and submit the feature
as a mpull request to the aws-cdk or related repos. Becoming 'active' is not a
as a pull request to the aws-cdk or related repos. Becoming 'active' is not a
rubber stamp, and in particular still does not mean the feature will ultimately
be merged; it does mean that the core team has agreed to it in principle and are
amenable to merging it.
Expand All @@ -88,7 +88,7 @@ Furthermore, the fact that a given RFC has been accepted and is 'active' implies
nothing about what priority is assigned to its implementation, nor whether
anybody is currently working on it.

Modifications to active RFCs can be down in followup PRs. We strive to write
Modifications to active RFCs can be done in followup PRs. We strive to write
each RFC in a manner that it will refelct the final design of the feature; but
the nature of the process means that we cannot expect every merged RFC to
actually reflect what the end result will be at the time of the next major
Expand All @@ -98,9 +98,9 @@ document.

## Implementing an RFC

The author of an RFC is not obligated to implement it. Of course, the RFC
author (like any other developer) is welcome to post an implementation for
review after the RFC has been accepted.
While the author of an RFC (like any other developer) is welcome to offer an
implementation for review after the RFC has been accepted, they have no
obligation to do so.

If you are interested in working on the implementation for an 'active' RFC, but
cannot determine if someone else is already working on it, feel free to ask
Expand Down

0 comments on commit 27cdf4b

Please sign in to comment.