CONTRIBUTING.md

For Contributors

Setup

Requirements

• Make:
  • macOS: $ xcode-select --install
  • Linux: https://www.gnu.org
  • Windows: $ choco install make https://chocolatey.org
• Python: $ asdf install https://asdf-vm.com
• PostgreSQL: $ brew install postgres
• direnv: https://direnv.net

To confirm these system dependencies are configured correctly:

$ make doctor

See the Developer Machine Setup wiki for more instructions.

Installation

Install project dependencies into a virtual environment:

$ make install

Data

To automatically create test accounts, update .envrc with your own voter information and run direnv allow. Then, generate new seed data:

$ make data

Development Tasks

Testing

Manually run the tests:

$ make test

or keep them running on change:

$ make dev

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

Static Analysis

Run linters and static analyzers:

$ make check

Continuous Integration

The CI server will report overall build status:

$ make all