From 230698a70def10b52761f6aeae40f83010404049 Mon Sep 17 00:00:00 2001 From: Normann Date: Thu, 20 Aug 2026 02:02:49 +0200 Subject: [PATCH] docs: use uv for development setup (#1236) * docs: use uv for development setup * docs: restore contributor footer * docs: run development commands with uv --- CONTRIBUTING.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28135cf4..07e90133 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,13 +27,10 @@ message style checks. ### Setup development environment -Setup virtual environment, then activate virtual environment and install development dependencies. +Use `uv` to create the virtual environment and install development dependencies. ```bash -python -m venv .venv -source .venv/bin/activate -pip install -r requirements-dev.txt -pip install -e . +uv sync --extra dev ``` Install make to get access to helpful shortcuts (documentation generation, manual formatting, etc.). @@ -61,14 +58,14 @@ Our code style checks use [`pre-commit`](https://pre-commit.com). To run formatting automatically before every commit: ```bash -pre-commit install -pre-commit install --hook-type commit-msg --hook-type pre-push +uv run pre-commit install +uv run pre-commit install --hook-type commit-msg --hook-type pre-push ``` Or run them manually: ```bash -pre-commit run --all-files +uv run pre-commit run --all-files ``` ### Tests @@ -76,7 +73,7 @@ pre-commit run --all-files Use `pytest` to run tests locally: ```bash -python -m pytest -vs --cov src --cov-report term-missing tests/ +uv run python -m pytest -vs --cov src --cov-report term-missing tests/ ``` ### Commit message style