Contributing

The team welcomes contributions! To make code changes to one of the Conjure repos:

Fork the repo and make a branch
Write your code (ideally with tests) and make sure the CircleCI build passes
Open a PR (optionally linking to a github issue)

Local Development

Prerequisites

Python2 (On macOS: brew install python2)
Python3 (On macOS: brew install python3)
pipenv (pip3 install pipenv)

We recommend the free VSCode editor to work on python projects.

One-time setup for development

Fork the repo
Create the virtual environment PIPENV_VENV_IN_PROJECT=1 pipenv --python 3 shell
Install all dependencies pipenv install --dev
Download and generate integration test dependencies ./scripts/prepare_integration_tests.sh
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
Use tox to run all tests using both python 2 and 3