From bb466d65a352dc4e4260f0be8a07b786cab5fbb1 Mon Sep 17 00:00:00 2001 From: Jacob Fuss Date: Tue, 11 Jun 2019 15:50:06 -0700 Subject: [PATCH 1/2] docs(contributing): Explain steps to test locally with SAM CLI --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78def1fc1..2a8c4179a 100644 --- 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 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 From fa622aa3aaab9e54708e3320a8001dbd818808ce Mon Sep 17 00:00:00 2001 From: Jacob Fuss Date: Tue, 11 Jun 2019 16:45:06 -0700 Subject: [PATCH 2/2] Link out to SAM CLI's Development Guide --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a8c4179a..7366f727c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ Looking at the existing issues is a great way to find something to contribute on ## Testing with SAM CLI -1. Activate Virtualenv that is used for SAM CLI development. +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)