Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,23 @@ 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

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
Expand Down
Loading