Contributing

Issues

Before opening an issue

Search the open and closed issues to see if it already exists.
Have a look at the architecture guide to familiarize yourself with this project's principles, intended usage, base assumptions and by-design limitations.

Opening an `enhancement` issue

Use the enhancement tag
Explain the use case or motivation
If relevant, provide a snippet (possibly in meta-code) that demonstrates the intended usage of the feature

Opening a `bug` issue

Use the tag bug
Indicate the affected versions
Provide:
- Steps to reproduce
- Your environment's details
- A file with the complete logs/outputs/stacktrace in case of an exception(*)

(*): You may want to redact any personal/private details or confidential info

Opening a Pull Request

First, pick an open issue or open a new one.
Follow the Developer Instructions below to install the recommended software and set up your environment
Make your changes and validate them with make test
Push your changes and open the PR:
- The PR should include a link to the issue
- The PR name should comply with the conventional commits pattern

Developer instructions

Recommended Software

UV
Rclone CLI (required for artifact transfer from/to cloud storage)

Environment setup

Fork and clone this repo
From the cloned repo's root, run make install This is going to:
- Install the project source code and requirements to a virtualenv
- Install the pre-commit hooks
The Python interpreter path for your IDE can be obtained with uv run which python