Notes on how to contribute

Setting up a dev environment

These instructions assume you are developing in a virtualenv, you are, aren’t you?

  1. Clone the code into your virtualenv
  2. You should have the packages in dev-requirements.txt installed
pip install -r requirements-dev.txt
  1. install dhp as editable
pip install -e .
  1. Tests should be passing locally
  1. Editing documentation - you will need to build the docs initially then use docwatch, to auto build the docs when saved as you edit.
cd docs
make html
cd ..

Pull Requests

  • Code should be passing all tests locally, bonus points for passing
  • New code should have new tests to go along with it.
  • Code should be pep8 compliant
  • update documentation as necessary
  • update contributors.rst
  • make a pull request