Contributing Code

Prerequisites

1. Virtualenv
2. Fork of this repo
3. Local clone of your fork

Getting Started

1. In the root directory run virtualenv venv to setup your virtualenvironment
2. . venv/bin/activate
3. pip install --editable . This creates an editable working copy of the demo data
   • Your virtualenv needs to have setuptools installed to do this step. You may need to run pip install setuptools if this step fails

You now have a local copy of code you can hack on.

Housekeeping

1. Never work on master, always branch from develop
2. Document your function calls
3. Unit testing will get your code in faster (Though no unit tests actually exist yet)