Skip to content

Commit 5ae0157

Browse files
committed
documentation: update contributing.md w/ venv instructions and pip install fixes
1 parent 95e5db0 commit 5ae0157

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ Before sending us a pull request, please ensure that:
6161
1. Follow the instructions at [Modifying an EBS Volume Using Elastic Volumes (Console)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/requesting-ebs-volume-modifications.html#modify-ebs-volume) to increase the EBS volume size associated with the newly created EC2 instance.
6262
1. Wait 5-10min for the new EBS volume increase to finalize.
6363
1. Allow EC2 to claim the additional space by stopping and then starting your EC2 host.
64+
2. Set up a venv to manage dependencies:
65+
1. `python -m venv ~/.venv/myproject-env` to create the venv
66+
2. `source ~/.venv/myproject-env/bin/activate` to activate the venv
67+
3. `deactivate` to exit the venv
6468

6569

6670
### Pull Down the Code
@@ -74,8 +78,8 @@ Before sending us a pull request, please ensure that:
7478
### Run the Unit Tests
7579

7680
1. Install tox using `pip install tox`
77-
1. Install coverage using `pip install .[test]`
78-
1. cd into the sagemaker-python-sdk folder: `cd sagemaker-python-sdk` or `cd /environment/sagemaker-python-sdk`
81+
1. cd into the github project sagemaker-python-sdk folder: `cd sagemaker-python-sdk` or `cd /environment/sagemaker-python-sdk`
82+
1. Install coverage using `pip install '.[test]'`
7983
1. Run the following tox command and verify that all code checks and unit tests pass: `tox tests/unit`
8084
1. You can also run a single test with the following command: `tox -e py310 -- -s -vv <path_to_file><file_name>::<test_function_name>`
8185
1. You can run coverage via runcvoerage env : `tox -e runcoverage -- tests/unit` or `tox -e py310 -- tests/unit --cov=sagemaker --cov-append --cov-report xml`

0 commit comments

Comments
 (0)