CONTRIBUTING.md

Installation

Build from source

Dependencies needed to build and run Ragbits from the source code:

1. uv
2. python 3.10

Linting and formatting

We use ruff for linting and formatting our code. To format your code, run:

$ uv run ruff format

To lint the code, run:

$ uv run ruff check --fix

Type checking

We use mypy for type checking. To perform type checking, simply run:

$ uv run mypy .

Testing

We use pytest for testing. To run the tests, simply run:

$ uv run pytest

Running integration tests requires Docker — all backing services (PostgreSQL/pgvector, Weaviate) are started automatically via testcontainers. No manual setup is needed.

Install pre-commit or pre-push hooks

We also recommend to run checkers on pre-commit/push hook. To set it up, follow these steps:

$ uv run scripts/install_git_hooks.py

Then decide whether you want to run the checks before each commit or before each push.