From 03b74c1878a9d81b28c8698667293eec0ed93d08 Mon Sep 17 00:00:00 2001 From: Johannes Bornhold Date: Tue, 9 Dec 2025 16:30:44 +0100 Subject: [PATCH] Document a "uv" based development environment --- CONTRIBUTING.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abe35a1c0ee..26423ff41c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,31 @@ git clone https://github.com/Aider-AI/aider.git cd aider ``` -### Create a Virtual Environment +### Using uv (Recommended) + +The easiest way to get started is using [uv](https://docs.astral.sh/uv/). `uv` handles Python versions, virtual environments, and dependencies automatically. + +To start a development shell with all dependencies installed: + +``` +uv run --extra dev bash +# or +uv run --extra dev zsh +``` + +To run tests: + +``` +uv run --extra dev pytest +``` + +To run the CLI to test your changes: + +``` +uv run cecli +``` + +### Manual Setup: Create a Virtual Environment It is recommended to create a virtual environment outside of the repository to keep your development environment isolated.