Skip to content

Files

30 lines (16 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

30 lines (16 loc) · 1.41 KB

CONTRIBUTING


Thanks for your interest in contributing to this package! We're hoping it can be made even better through community contributions.

Requests and feedback

For any bugs, issues or feature requests please open an issue on the project.

Requirements for contributions

Code formatting

Contributions should be formatted with black and naming should follow pep8. The project uses pre-commit to manage pre-commit hooks. After setting up your development environment simple run pre-commit install to initalise pre-commit for the repository. Black is included in the pre-commit hook configuration.

Tests

All existing tests must pass and new functionality added must be tested. Tests must be written with pytest. We aim for 100% coverage of new functionality.

Docstrings

Docstrings need to be updated or added for new functionality.

List of contributors

Prior to the open source release of the package the functionality lived in the tubular package of which there were many contributors from the LV= GI Data Science Team.