CONTRIBUTING.md

For Contributors

Setup

Requirements

• Make:
  • Windows: http://mingw.org/download/installer
  • Mac: http://developer.apple.com/xcode
  • Linux: http://www.gnu.org/software/make
• pipenv: http://docs.pipenv.org
• Pandoc: http://johnmacfarlane.net/pandoc/installing.html
• Graphviz: http://www.graphviz.org/Download.php

To confirm these system dependencies are configured correctly:

$ make doctor

Installation

Install project dependencies into a virtual environment:

$ make install

Development Tasks

Testing

Manually run the tests:

$ make test

or keep them running on change:

$ make watch

In order to have OS X notifications, brew install terminal-notifier.

Documentation

Build the documentation:

$ make doc

Static Analysis

Run linters and static analyzers:

$ make pylint
$ make pycodestyle
$ make pydocstyle
$ make check  # includes all checks

Continuous Integration

The CI server will report overall build status:

$ make ci

Release Tasks

Release to PyPI:

$ make upload