Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

93 lines (62 loc) · 1.43 KB

Contributor Guide

Setup

Requirements

To confirm these system dependencies are configured correctly:

$ make bootstrap
$ make doctor

Installation

Install project dependencies into a virtual environment:

$ make install

Development Tasks

Manual

Run the tests:

$ make test

Run static analysis:

$ make check

Build the documentation:

$ make docs

Automatic

Keep all of the above tasks running on change:

$ make dev

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

Continuous Integration

The CI server will report overall build status:

$ make all

Demo Tasks

Run the program:

$ make run

Launch an IPython session:

$ make shell

Release Tasks

Release to PyPI:

$ make upload