From 5a36f071de05dd2e3d8bca96a882e197e7c00f30 Mon Sep 17 00:00:00 2001 From: "Felina Rivera Calzadillas (ROGUH)" Date: Mon, 18 May 2026 17:02:27 -0600 Subject: [PATCH] Update CONTRIBUTING.md guide to use `uv` instead of `venv` and `pip` --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 915b818a66..0f2d8dab1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,8 +51,8 @@ The rest of this guide assumes you've already done the following: 4. [Cloned your fork locally](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) 5. Changed directories into your local Arcade clone's folder -[Creating & using a virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) -is also strongly recommended. +[The UV package manager](https://docs.python.org/3/library/venv.html#creating-virtual-environments) +is strongly recommended. ## Installing Arcade in Editable Mode @@ -60,10 +60,14 @@ To install all necessary development dependencies, run this command in your terminal from inside the top level of the Arcade directory: ```bash -pip install -e '.[dev]' +uv sync ``` -If you get an error like the one below, you probably need to update your pip version: +For `uv`, either run `make.py` with `uv run ./make.py` or run `. .venv/bin/activate` when you open a terminal before running `make.py`. + +Alternatively, use Python's builtin `venv` and run `pip install -e .[dev]` to use editable mode. + +If you get an error like the one below, you probably need to update your pip version or install a newer Python version: ``` ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /home/user/Projects/arcade