docs(contributing): Explain steps to test locally with SAM CLI (#119)

aws · Jun 12, 2019 · db889c8 · db889c8
1 parent df3b9d8
commit db889c8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,6 +44,12 @@ GitHub provides additional document on [forking a repository](https://help.githu
 Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/aws-lambda-builders/labels/help%20wanted) issues is a great place to start. 
 
 
+## Testing with SAM CLI
+
+1. [Activate Virtualenv](https://github.com/awslabs/aws-sam-cli/blob/develop/DEVELOPMENT_GUIDE.md) that is used for SAM CLI development.
+2. Navigate to aws-lambda-builders project on your machine
+3. `pip install -e .` (This will install the editable version of the aws-lambda-builers into SAM CLI's Virtualenv)
+
 ## 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