Contributions to MELD are welcome. The preferred approach is to fork and submit a pull request.
We use black for automatic code formatting. Just let it do its thing and live with the output.
We have settled on the numpydoc format for docstrings. All new code should have full docstrings using this convention. The existing docstrings are a mix of formats and need to be updated. There is an open issue for this.
We strive to have as much test coverage as possible, although this is hard as the CI severs do not currently support running GPU code.
New code should have tests whenever feasible. To run the tests, use python -m unittest discover
.
We are also adding python type annotations to the code base. All new code should have type annotations and we aim to add them to existing
code over time. To run the type checks, use mypy meld
.