Skip to content

Commit

Permalink
feat(docs): add design process description & basic style guide (#1229)
Browse files Browse the repository at this point in the history
Fixes awslabs/cdk-ops#177
  • Loading branch information
RomainMuller authored and Elad Ben-Israel committed Dec 5, 2018
1 parent 6184423 commit 5ffa7e2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,30 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
7. Once approved and tested, a maintainer will squash-merge to master and will use your PR title/description as the
commit message.

## Design Process

In order to enable efficient collaboration over design documents, the following process should be followed:

1. Open an issue describing the requirements and constraints the design must satisfy
+ Provide a clear list of use-cases that the design intends to address
2. Open a pull request with a Markdown document describing the proposed design. The document should be placed in the
`design` directory at the root of the repository.
+ Design discussions are tracked using the comment stream of the pull request
+ The design document will be merged in and retained as if it were code

## Style Guide

### Markdown

* Adhere to the [GitHub Flavored Markdown](https://github.github.com/gfm/) syntax
* `120` character lines
* ATX style headings (e.g: `## H2 heading`)

### Typescript and Javascript

* `2` space indentation
* `120` character lines

## Tools

The CDK is a big project, and, at the moment, all of the CDK modules are mastered in a single monolithic repository
Expand Down
Empty file added design/.gitkeep
Empty file.

0 comments on commit 5ffa7e2

Please sign in to comment.