You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,23 @@ reported the issue. Please try to include as much information as you can. Detail
19
19
* Any modifications you've made relevant to the bug
20
20
* A description of your environment or deployment
21
21
22
+
## Setting up your development environment [optional, but recommended]
23
+
24
+
* Set up the Cloud9 environment:
25
+
* Instance type: You'll need at least 4 GB of RAM to avoid running into memory issues. We recommend at least a t3.medium to run the unit tests. Larger hosts will reduce the chance of encountering resource limits.
26
+
* Follow the instructions at [Creating a Cloud9 EC2 Environment](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html#create-environment-main) to set up a Cloud9 EC2 environment
27
+
* Expand the storage of the EC2 instance from 10GB to 20GB
28
+
* Because you'll need a minimum of 11GB of disk storage on the EC2 instance to run the package's unit tests, you'll need to expand your EC2 volume size. We recommend at least 20GB. A larger volume will reduce the chance of encountering resource limits.
29
+
* 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.
30
+
* Wait 5-10min for the new EBS volume increase to take effect.
31
+
* Allow EC2 to claim the additional space by stopping and then starting your EC2 host.
32
+
* Create a fork of this package on GitHub. You should end up with a fork at `https://github.com/<username>/sagemaker-python-sdk`
33
+
* Follow the instructions at [Fork a repo](https://help.github.com/en/articles/fork-a-repo) to fork a GitHub repository.
34
+
* In the Cloud9 UI, pull down this package by clicking on "Clone from Github" or running the following command in the Cloud9 terminal: `git clone https://github.com/<username>/sagemaker-python-sdk` where <username> is your github username.
35
+
* Install tox using `pip install tox`
36
+
* Install coverage using `pip install .[test]`
37
+
* cd into the sagemaker-python-sdk package: `cd sagemaker-python-sdk` or `cd /environment/sagemaker-python-sdk`
38
+
* Run the following tox command and verify that all unit tests pass: `tox tests/unit`
22
39
23
40
## Contributing via Pull Requests
24
41
Contributions via pull requests are much appreciated.
0 commit comments