Contributing to Cistell¶

The project is in early development and not yet open for external contributions. Once the API stabilises, this guide will be updated with contribution instructions.

In the meantime, feel free to open issues or participate in discussions on the repository.

Setting Up the Development Environment¶

Fork and clone the repository:

git clone https://github.com/pynenc/cistell.git
cd cistell

Install uv (dependency manager): see https://docs.astral.sh/uv/getting-started/installation/\.
Install dependencies:
```
uv sync
```
Install Rust toolchain (needed for the native extension): see https://rustup.rs/\.
Build the native extension (development mode):
```
maturin develop
```
Install pre-commit hooks:
```
uv run pre-commit install
```

Run tests:

uv run pytest tests/
cargo test --workspace --exclude cistell-py

Running Tests with Coverage¶

uv run coverage run -m pytest
uv run coverage report