Skip to content

Improvement: Update dev instructions #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2025
Merged

Improvement: Update dev instructions #172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,20 @@ The team welcomes contributions! To make code changes to one of the Conjure rep
## Local Development

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

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

### One-time setup for development

1. Fork the repo
1. Create the virtual environment `PIPENV_VENV_IN_PROJECT=1 pipenv --python 3 shell`
1. Install all dependencies `pipenv install --dev`
1. Download and generate integration test dependencies `./scripts/prepare_integration_tests.sh`
1. From within a pipenv shell, run `code .` to open a new VSCode window.
2. Create the virtual environment `PIPENV_VENV_IN_PROJECT=1 pipenv --python 3 shell`
Copy link

@dtobin dtobin Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't necessary since markdown will already show this as a sequential list, but I guess it doesn't hurt.

3. Install all dependencies `pipenv install --dev`
4. Download and generate integration test dependencies `./scripts/prepare_integration_tests.sh`
5. From within a pipenv shell, run `code .` to open a new VSCode window.

### Development tips

- Use `python setup.py format` to quickly reformat all code using [Black](https://github.com/ambv/black)
- Use `tox` to run all tests using both python 2 and 3
- 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`.