We welcome new contributions towards ANNchor. Feel free to get in touch if you are thinking about contributing, and follow the rough guidelines below.
If you find any issues/bugs in the software, please file an issue. If possible, provide details on how to reproduce the issue, and we'll try our best to get it fixed.
You are welcome to contribute towards the ANNchor codebase (e.g bug-fixes, docs, examples, new features). Please fork the project, make your changes, and submit a pull request to the main repository. Make sure to include clear details about the purpose of your pull request.
ANNchor uses the black code formatter, which can be installed
via pip (pip install black). Simply install and run in the project root. Note that we run black with a maximum line length of 79.
black --line-length 79 ./Make sure that any contributions pass the unit tests in annchor/tests. The easiest way to do this is by running pytest on your repository before making a pull request.
pytest --cov=annchor annchor/tests