How to contribute¶

Thanks for taking the time to contribute!

From opening a bug report to creating a pull request: every contribution is appreciated and welcome. If you're planning to implement a new feature or change the API please create an issue first. This way we can ensure that your precious work is not in vain.

Setup and dependency installation¶

Clone the repo git clone https://github.com/FOR-sight-ai/interpreto.git.
Go to your freshly downloaded repo cd interpreto
Create a virtual environment and install the necessary dependencies for development.

We use uv to manage Interpreto dependencies. If you dont have uv, you should install with make uv-download.

To install dependencies and prepare pre-commit hooks you would need to run:

make install # Regular dependencies for normal usage

or

make install-dev # Dev dependencies including docs and linting

To activate your .venv run source .venv/bin/activate.

Welcome to the team!

Codestyle¶

After installation you may execute code formatting.

make lint

Many checks are configured for this project. Command make lint will check style with ruff. We use Google style for docstrings.

Before submitting¶

Before submitting your code please do the following steps:

Add any changes you want
Add tests for the new changes
Edit documentation if you have changed something significant
Run make fix-style to format your changes.
Run make lint to ensure that formats are okay.
Write a good commit message.

Other help¶

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.