40 lines
571 B
Markdown
40 lines
571 B
Markdown
# Contributing
|
|
|
|
## TL;DR
|
|
|
|
### 1 Install system packages
|
|
|
|
```bash
|
|
sudo pacman -Syu --needed \
|
|
base-devel \
|
|
git \
|
|
python \
|
|
uv \
|
|
sqlite \
|
|
curl \
|
|
wget \
|
|
openssh \
|
|
squashfs-tools \
|
|
e2fsprogs \
|
|
caddy \
|
|
podman
|
|
```
|
|
|
|
Notes:
|
|
- `uv` is package/dependency runner used by repo.
|
|
- `squashfs-tools`, `openssh`, and `e2fsprogs` are needed for `get_rootfs.bash` image prep flow.
|
|
|
|
### 2 Bootstrap project
|
|
|
|
```bash
|
|
uv sync
|
|
```
|
|
|
|
### 3 Day-to-day commands
|
|
|
|
```bash
|
|
uv run python manage.py check
|
|
uv run pytest -n 5 -q
|
|
uv run ruff check . --fix
|
|
uv run ruff format .
|
|
```
|