Skip to content

Commit

Permalink
chore: fix typos in CONTRIBUTING.md (aws#1673)
Browse files Browse the repository at this point in the history
  • Loading branch information
tokkiyaa authored and rix0rrr committed Feb 6, 2019
1 parent 1d7198a commit ff99403
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing to the AWS Cloud Development Kit

Thanks for your interest in contibuting to the AWS CDK! ❤️
Thanks for your interest in contributing to the AWS CDK! ❤️

This document describes how to set up a development environment and submit your contributions. Please read it carefully
and let us know if it's not up-to-date (even better, submit a PR with your corrections ;-)).

## Pull Requests

1. If there isn't one already, open an issue describing what you intend to contribute. It's usful to communicate in
1. If there isn't one already, open an issue describing what you intend to contribute. It's useful to communicate in
advance, because sometimes, someone is already working in this space, so maybe it's worth collaborating with them
instead of duplicating the efforts.
1. Work your magic. Here are some guidelines:
Expand All @@ -18,7 +18,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
single commit, so you can use that to frame your scope.
1. Create a commit with the proposed change changes:
* Commit title and message (and PR title and description) must adhere to [conventionalcommits].
* The title must begin with `feat(module): title`, `fix(module): title`, `reactor(module): title` or
* The title must begin with `feat(module): title`, `fix(module): title`, `refactor(module): title` or
`chore(module): title`.
* Title should be lowercase.
* No period at the end of the title.
Expand All @@ -28,8 +28,8 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
* Commit message should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
* Shout out to collaborators.
* If not obvious (i.e. from unit tests), describe how you verified that your change works.
* If this commit includes a breaking change, the commit message must end with a a single pragraph
`BREAKING CHANGE: description of what broke and how to achieve this beahvior now`.
* If this commit includes a breaking change, the commit message must end with a single paragraph
`BREAKING CHANGE: description of what broke and how to achieve this behavior now`.
2. Push to a fork or to a branch (naming convention: `<user>/<feature-bug-name>`)
3. Submit a Pull Requests on GitHub and assign the PR for a review to the "awslabs/aws-cdk" team.
5. Discuss review comments and iterate until you get at least one “Approve”. When iterating, push new commits to the
Expand Down Expand Up @@ -69,7 +69,7 @@ In order to enable efficient collaboration over design documents, the following

The CDK is a big project, and, at the moment, all of the CDK modules are mastered in a single monolithic repository
(uses [lerna](https://github.com/lerna/lerna)). There are pros and cons to this approach, and it's especially valuable
to maintain integrity in the early stage of thr project where things constantly change across the stack. In the future
to maintain integrity in the early stage of the project where things constantly change across the stack. In the future
we believe many of these modules will be extracted to their own repositories.

Another complexity is that the CDK is packaged using [jsii](https://github.com/awslabs/jsii) to multiple programming
Expand Down Expand Up @@ -122,7 +122,7 @@ alias lw='lr watch'
The `pkglint` tool "lints" package.json files across the repo according to [rules.ts](tools/pkglint/lib/rules.ts).

To evaluate (and attempt to fix) all package linting issues in the repo, run the following command from the root of the
repository (after boostrapping):
repository (after bootstrapping):

```console
$ lerna run pkglint
Expand Down

0 comments on commit ff99403

Please sign in to comment.