Contributing
Bug reports, fixes and ideas are welcome. Security problems go through SECURITY.md, never a public issue.
The full guide is docs/development.md. The short version:
- Python through uv only.
uv sync --frozen --extra publish --extra mcp --group browser. - Before a pull request, run what covers your change:
Touching
Terminal window uv run ruff check .uv run pytest -q -rsuv run python tools/fixtures/generate.py --checkdata/,pyproject.tomlor theDockerfile? Build both images too:docker build .anddocker build --target renderer .. - Made-up data only. No real account, character, guild, host or address
in code, tests, docs or screenshots. Fixtures come from
tools/fixtures/generate.py;tests/test_public_scan.pychecks the rest. - Dependencies: change
pyproject.toml, runuv lock, commit both. CI fails whenuv.lockis out of step or a locked package has a known vulnerability. - One change per pull request, with a CHANGELOG line when a player or an operator would notice it (and an “Upgrading” note for any changed variable, port, volume or route).
Optional: pre-commit install runs ruff, the fixture check and actionlint
on each commit (.pre-commit-config.yaml).
By contributing you agree that your work is released under the project’s license, GPL-3.0-only, and you follow the code of conduct.