FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Update CONTRIBUTING.md · richdia/sendgrid-python@d8967ae · GitHub

Commit d8967ae

Browse files
authored
Update CONTRIBUTING.md
Adding clarification to docker vs local install and running python setup.py install command
1 parent 31221da commit d8967ae

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,13 @@ In order to make the process easier, we've included a [sample bug report templat
5959
We welcome direct contributions to the sendgrid-python code base. Thank you!
6060

6161
### Development Environment ###
62-
63-
#### Using Docker ####
62+
#### There are two ways to get set up: ####
63+
#### 1. Using Docker ####
64+
This is usually the easiest and fastest way to get set up.
6465
You can use our Docker image to avoid setting up the development environment yourself. See [USAGE.md](https://github.com/sendgrid/sendgrid-python/blob/master/docker/USAGE.md).
6566

66-
#### Install and Run Locally ####
67+
#### - OR - ####
68+
#### 2. Install and Run Locally ####
6769

6870
##### Prerequisites #####
6971

@@ -150,7 +152,12 @@ pyenv install 2.6.9
150152
pyenv install 2.7.11
151153
pyenv install 3.4.3
152154
pyenv install 3.5.0
155+
```
156+
Make sure to change the current working directory to your local version of the repo before running the following command:
157+
```
153158
python setup.py install
159+
```
160+
```
154161
pyenv local 3.5.0 3.4.3 2.7.11 2.6.9
155162
pyenv rehash
156163
```

0 commit comments

Comments
 (0)

Back | FazBrowse Home | New Git URL