From f13b1ac15371927ae7dac09be082b1489457ff4b Mon Sep 17 00:00:00 2001 From: Carolyn Nguyen Date: Fri, 14 May 2021 13:13:38 -0700 Subject: [PATCH 1/2] fix: Fix git checkout command and reorder unit test steps --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39ba49b..705a4e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,8 +57,8 @@ Before sending us a pull request, please ensure that: ### Running the Unit Tests 1. Install tox using `pip install tox` -1. Install test dependencies, including coverage, using `pip install .[test]` 1. cd into the aws-step-functions-data-science-sdk-python folder: `cd aws-step-functions-data-science-sdk-python` or `cd /environment/aws-step-functions-data-science-sdk-python` +1. Install test dependencies, including coverage, using `pip install ".[test]"` 1. Run the following tox command and verify that all code checks and unit tests pass: `tox tests/unit` You can also run a single test with the following command: `tox -e py36 -- -s -vv ::` @@ -80,7 +80,7 @@ You should only worry about manually running any new integration tests that you 1. Create a new git branch: ```shell - git checkout -b my-fix-branch master + git checkout -b my-fix-branch main ``` 1. Make your changes, **including unit tests** and, if appropriate, integration tests. 1. Include unit tests when you contribute new features or make bug fixes, as they help to: From ad112f802693f2bf2b1e1c48fdc4df00faa5081d Mon Sep 17 00:00:00 2001 From: Carolyn Nguyen Date: Fri, 14 May 2021 15:06:42 -0700 Subject: [PATCH 2/2] Removed optional start_point argument in git checkout --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 705a4e3..b014669 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ You should only worry about manually running any new integration tests that you 1. Create a new git branch: ```shell - git checkout -b my-fix-branch main + git checkout -b my-fix-branch ``` 1. Make your changes, **including unit tests** and, if appropriate, integration tests. 1. Include unit tests when you contribute new features or make bug fixes, as they help to: