Skip to content

documentation: Updated git checkout command and reorder unit test steps #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 17, 2021
Merged

documentation: Updated git checkout command and reorder unit test steps #133

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f13b1ac
fix: Fix git checkout command and reorder unit test steps
ca-nguyen May 14, 2021
ad112f8
Removed optional start_point argument in git checkout
ca-nguyen May 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path_to_file><file_name>::<test_function_name>`
Expand All @@ -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:
Expand Down