Ctrl+K

Contributing Guide

Contributing Guide#

Contributing to OTT#

We’d love to accept your contributions to this project.

There are many ways to contribute to OTT, with the most common ones being contribution of code, documentation to the project, participating in discussions or raising issues.

Contributing code or documentation#

  1. fork the repository using the Fork button on GitHub.

  2. git clone https://github.com/<YOUR_USERNAME>/ott.git ott && \
cd ott && \
pip install -e '.[dev]' && \
pre-commit install

When committing changes, sometimes you might want or need to bypass the pre-commit checks. This can be done via the --no-verify flag as:

git commit --no-verify -m "<SOME_COMMIT_MESSAGE>"

Running tests#

In order to run tests, we utilize tox:

tox run  # run linter and all tests on all available Python versions
tox run -- -n auto -m fast  # run linter and fast tests in parallel
tox -e py3.8  # run all tests on Python3.8
tox -e py3.9 -- -k "test_euclidean_point_cloud"  # run tests matching the expression on Python3.9
tox -e py3.10 -- --memray  # test also memory on Python3.10

Alternatively, tests can be also run using the pytest:

python -m pytest

This requires the '[test]' extra requirements to be installed as pip install -e.'[test]'.

Documentation#

From the root of the repository, run:

tox -e clean-docs,build-docs,lint-docs  # remove, build and lint the documentation

Installing PyEnchant is required to run spellchecker, please refer to the installation instructions. On macOS Silicon, it may be necessary to also set PYENCHANT_LIBRARY_PATH environment variable, as, e.g., export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.2.dylib. False positives and correctly spelled words can be added to one of the files in docs/spelling.

Building the package#

The package can be built using:

tox -e build-package

Afterwards, the built package will be located under dist/.

Code reviews#

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community guidelines#

We abide by the principles of openness, respect, and consideration of others of the Python Software Foundation’s code of conduct.

Contents