Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.08 KB
Raw

Contributing to equilib

I want to make contributing to this project as easy and transparent as possible.

Issues

See GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Test

Use pytest testing framework and testing data that needs to be downloaded, please make sure that test are passing:

pytest

Check typing

Use mypy to check Python typing and guard API consistency, please make sure next command doesn't complain prior to submission:

mypy equilib --ignore-missing-imports

Coding Style

  • We follow PEP8 and use typing.
  • Use black for style enforcement and linting. Install black through pip install black.

We also use pre-commit hooks to ensure linting and style enforcement. Install the pre-commit hooks with pip install pre-commit && pre-commit install.

Documentation

WIP

TODO:

  • Documentation
  • Better mypy type hints
  • Type hints for tests (pretty ugly right now)