Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 579 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (11 loc) · 579 Bytes

Contributing Code

Style

We follow PEP8 with the exception of maximum line length set to 120. We use numpy style docstrings with the exception of ommitting argument types in the docstrings in favour of type hints in function and class signatures. We use mypy to typecheck code with exceptions for libraries with missing stubs specified in setup.cfg.

Pull requests

Before a PR is accepted, TravisCI builds must pass. We use flake8 for linting (with exceptions to PEP8 described in setup.cfg and pytest for testing. We use sphinx for building documentation.