Skip to content

Commit 5ffa7e2

Browse files
RomainMullerElad Ben-Israel
authored and
Elad Ben-Israel
committed
feat(docs): add design process description & basic style guide (#1229)
Fixes awslabs/cdk-ops#177
1 parent 6184423 commit 5ffa7e2

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,30 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
4141
7. Once approved and tested, a maintainer will squash-merge to master and will use your PR title/description as the
4242
commit message.
4343

44+
## Design Process
45+
46+
In order to enable efficient collaboration over design documents, the following process should be followed:
47+
48+
1. Open an issue describing the requirements and constraints the design must satisfy
49+
+ Provide a clear list of use-cases that the design intends to address
50+
2. Open a pull request with a Markdown document describing the proposed design. The document should be placed in the
51+
`design` directory at the root of the repository.
52+
+ Design discussions are tracked using the comment stream of the pull request
53+
+ The design document will be merged in and retained as if it were code
54+
55+
## Style Guide
56+
57+
### Markdown
58+
59+
* Adhere to the [GitHub Flavored Markdown](https://github.github.com/gfm/) syntax
60+
* `120` character lines
61+
* ATX style headings (e.g: `## H2 heading`)
62+
63+
### Typescript and Javascript
64+
65+
* `2` space indentation
66+
* `120` character lines
67+
4468
## Tools
4569

4670
The CDK is a big project, and, at the moment, all of the CDK modules are mastered in a single monolithic repository

design/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)