Files
aprsd/CONTRIBUTING.md
hemna e0da8876fd docs: fix CONTRIBUTING environment setup
- Environment setup created the venv before cloning the repo, so uv
  operated in the wrong directory; reorder clone first
- pre-commit install ran before pre-commit was installed; the dev
  extra provides it (uv run pre-commit install)
- Drop the standalone pip-tools install (comes via the dev extra)
- Fix 'aprstastic' -> 'aprsd'
- Add testing instructions (uv run pytest / uv run tox)
2026-09-20 15:43:01 -04:00

587 B

CONTRIBUTING

Code contributions are welcomed and appreciated. Just submit a PR!

The current build environment uses pre-commit, and uv.

Environment setup:

pip install uv
git clone git@github.com:craigerl/aprsd.git
cd aprsd
uv venv
uv pip install -e ".[dev]"
uv run pre-commit install

# Optionally run the pre-commit scripts at any time
uv run pre-commit run --all-files

Running and testing:

From the aprsd directory:

# Running
uv run aprsd

# Testing
uv run pytest tests

# Full matrix (lint + all supported Python versions)
uv run tox