Skip to content

Commit 512aadf

Browse files
authored
Improvement: Update dev instructions (#172)
Update dev instructions
1 parent 4b32cc2 commit 512aadf

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ The team welcomes contributions! To make code changes to one of the Conjure rep
99
## Local Development
1010

1111
### Prerequisites
12-
- Python2 (On macOS: `brew install python2`)
1312
- Python3 (On macOS: `brew install python3`)
1413
- [pipenv](https://github.com/pypa/pipenv) (`pip3 install pipenv`)
1514

16-
_We recommend the free [VSCode](https://code.visualstudio.com/) editor to work on python projects._
15+
_We recommend [VSCode](https://code.visualstudio.com/) to work on python projects._
1716

1817
### One-time setup for development
1918

2019
1. Fork the repo
21-
1. Create the virtual environment `PIPENV_VENV_IN_PROJECT=1 pipenv --python 3 shell`
22-
1. Install all dependencies `pipenv install --dev`
23-
1. Download and generate integration test dependencies `./scripts/prepare_integration_tests.sh`
24-
1. From within a pipenv shell, run `code .` to open a new VSCode window.
20+
2. Create the virtual environment `PIPENV_VENV_IN_PROJECT=1 pipenv --python 3 shell`
21+
3. Install all dependencies `pipenv install --dev`
22+
4. Download and generate integration test dependencies `./scripts/prepare_integration_tests.sh`
23+
5. From within a pipenv shell, run `code .` to open a new VSCode window.
2524

2625
### Development tips
2726

2827
- Use `python setup.py format` to quickly reformat all code using [Black](https://github.com/ambv/black)
29-
- Use `tox` to run all tests using both python 2 and 3
28+
- Run `tox` to run all unit tests, integration tests, mypy, and lint. Use `-e` for individual tasks e.g. `tox -e py3`, `tox -e lint`.

0 commit comments

Comments
 (0)