Skip to content

Contributing

Development Setup

Install the default contributor environment:

make install-dev

Install the fuller environment, including docs and test extras:

make install

For local network and plotting work, the examples use the package extras in their own pyproject.toml files. The repo test environment now also includes the network stack so the deterministic graph-cache tests run locally and in CI.

Common Commands

make test
make lint
make docs
make docs-build
make ci

Repository standards

  • keep implemented behavior honest and small rather than speculative
  • update docs alongside package exports
  • keep parser-level tests deterministic and local by default
  • prefer committed real snapshot slices over packaged synthetic sample data
  • keep live snapshot and live OSM refresh tests opt-in through env vars

Docs and API surface

  • docs/api.md is generated from the documented subway_access.* public modules
  • scripts/audit_public_api.py checks that the documented public modules and __all__ exports stay aligned
  • archived planning material lives under docs/og-context/ and should not be used as the public docs navigation