CONTRIBUTING.md

Installation

Build from source

To build and run Ragbits from the source code:

1. Requirements: uv & python 3.10 or higher
2. Install dependencies and run venv in editable mode:

$ source ./setup_dev_env.sh

Linting and formatting

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

$ uvx ruff format

To lint the code, run:

$ uvx ruff check --fix

Type checking

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

$ uv run mypy .

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.