Skip to content

Commit ceab3c7

Browse files
authored
Create CONTRIBUTING.md
1 parent b074faf commit ceab3c7

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# How To Contribute
2+
This repo is designed to be a collection of aws serverless architecture patterns built with cdk. That means it should
3+
eventually hold a cdk version of all patterns presented by AWS heros. If you want to contribute follow these steps:
4+
5+
1. Find a pattern that you want to share
6+
2. Open an issue on this repo stating that you want to add this pattern so other people don't duplicate effort. Include links to arch pics in the issue
7+
3. Branch the repo into your own personal github account
8+
4. Build your pattern, make sure you add unit tests and a useful level of documentation including a simple arch diagram. Please make sure you credit the original creator of the pattern, this is not about stealing content.
9+
5. Make sure your pattern has the npm run deploy task added
10+
6. Open up a pull request and start the merge discussion!

0 commit comments

Comments
 (0)