CONTRIBUTING.md

Contributing to bio2zarr

Development setup

We use uv for dependency management.

Clone the repository and install all development dependencies:

git clone https://github.com/sgkit-dev/bio2zarr.git
cd bio2zarr
uv sync --group dev

Running tests

uv run pytest

Linting

We use prek for pre-commit linting, configured in prek.toml. Install it as a pre-commit hook:

uv run prek install

Run all checks manually:

uv run --only-group=lint prek -c prek.toml run --all-files

If local results differ from CI, run uv run prek cache clean.

Building documentation

cd docs && make

Pull requests

• Create a branch from main
• Ensure all CI checks pass
• Add a changelog entry if appropriate