Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 824 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 824 Bytes

Contribution Guidelines

Everyone is welcome to contribute to pykoop. To do so, please fork the repository and create a pull request when you're ready.

Contributed code must

  1. be documented using NumPy style docstrings,
  2. be formatted using using YAPF (see ./.style.yapf),
  3. use type annotations consistently,
  4. include relevant unit tests, and
  5. pass existing unit tests and checks.

If you are fixing a bug, please include a set of unit tests in your pull request that would fail without your changes.

If you notice a problem or would like to suggest an enhancement, please create an issue.