Skip to content

Commit ceb7c4d

Browse files
authored
Update CONTRIBUTING.md guide to use uv instead of venv and pip (#2858)
1 parent fb9c83d commit ceb7c4d

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,23 @@ The rest of this guide assumes you've already done the following:
5151
4. [Cloned your fork locally](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
5252
5. Changed directories into your local Arcade clone's folder
5353

54-
[Creating & using a virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments)
55-
is also strongly recommended.
54+
[The UV package manager](https://docs.python.org/3/library/venv.html#creating-virtual-environments)
55+
is strongly recommended.
5656

5757
## Installing Arcade in Editable Mode
5858

5959
To install all necessary development dependencies, run this command in your
6060
terminal from inside the top level of the Arcade directory:
6161

6262
```bash
63-
pip install -e '.[dev]'
63+
uv sync
6464
```
6565

66-
If you get an error like the one below, you probably need to update your pip version:
66+
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`.
67+
68+
Alternatively, use Python's builtin `venv` and run `pip install -e .[dev]` to use editable mode.
69+
70+
If you get an error like the one below, you probably need to update your pip version or install a newer Python version:
6771

6872
```
6973
ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /home/user/Projects/arcade

0 commit comments

Comments
 (0)