Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1021 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1021 Bytes

Development

Run tests in base directory with

pytest

Always run tests before pushing code.

Install for development with pip install -e . .

Comments should comply with the Numpy/Scipy documentation style. An example can also be found here. Code should comply to the pep8 coding style. You can check if the code complies by executing

pycodestyle
pydocstyle

Git commit messages follow Angular style. Uses python-semantic-release for versioning on travis-ci for pushs to master branch.

Create documentation with

rm -rf docs
pdoc --html --force --output-dir docs response.py
mv docs/response.html docs/index.html