Skip to content

Commit 5218dd0

Browse files
committed
Update CONTRIBUTING.md.
1 parent 3e2fa2f commit 5218dd0

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,38 +60,50 @@ We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikiped
6060

6161
## Environment
6262

63-
* AWS Data Wrangler practically only makes integrations. So we prefer to dedicate our energy / time writing integration tests instead of unit tests. We really like an end-to-end approach for all features.
63+
* AWS Data Wrangler practically only makes integrations with Databases and AWS APIs. So we prefer to dedicate our energy / time writing integration tests instead of unit tests. We really like an end-to-end approach for all features.
6464

65-
* All integration tests are between the local environment and a remote and real AWS services.
65+
* All integration tests are between the development environment and a remote and real AWS service.
6666

6767
* We have a Cloudformation to set up the AWS end (testing/cloudformation.yaml).
6868

6969
## Step-by-step
7070

71-
**DISCLAIMER**: Make sure to know what you are doing. This steps will charge some services on your AWS account. And requires a minimum security skills to keep your environment safe.
71+
**DISCLAIMER**: Make sure to know what you are doing. This steps will charge some services on your AWS account and requires a minimum security skill to keep your environment safe.
7272

7373
* Pick up a Linux or MacOS.
7474

75-
* Install Python 3.6
75+
* Install Python 3.6, 3.7 or 3.8
7676

7777
* Fork the AWS Data Wrangler repository and clone that into your development environment
7878

7979
* Go to the project's directory create a Python's virtual environment for the project
8080

81-
`python -m venv venv && source venv/bin/activate`
81+
`python -m venv .venv && source .venv/bin/activate`
8282

8383
* Then run the command bellow to install all dependencies:
8484

8585
`./setup-dev-env.sh`
8686

8787
* Go to the ``testing`` directory
8888

89-
* Configure the ``parameters.json`` file with your AWS environment infos (Make sure that your Redshift will not be open for the World! Configure your security group to only give access for your IP.)
89+
`cd testing`
9090

9191
* Deploy the Cloudformation stack
9292

93-
``./deploy-cloudformation.sh``
93+
``./cloudformation.sh``
94+
95+
* Go to the `EC2 -> SecurityGroups` console, open the `aws-data-wrangler-*` security group and configure to accept your IP from any TCP port.
96+
97+
``P.S Make sure that your security group will not be open for the World! Configure your security group to only give access for your IP.``
98+
99+
* To run the validations:
100+
101+
``./validations.sh``
94102

95103
* To run the complete test:
96104

97-
``./run-tests.sh``
105+
``./tests.sh``
106+
107+
* To run a specific test:
108+
109+
``pytest test_awswrangler/test_data_lake::test_athena_nested``

0 commit comments

Comments
 (0)