Contributor setup and validation

This page is for contributors changing Wetlands itself. User applications do not need the development dependencies or commands below.

Install the development environment

uv sync --frozen --group dev --extra shared-memory

Run the fast test suite

uv run --extra shared-memory pytest -m "not integration and not compat and not manual"

Run the representative real-Pixi suite

UV_PROJECT_ENVIRONMENT=.venv-py314 uv run --python 3.14 --extra shared-memory pytest tests/test_v2_pixi_integration.py

This suite downloads and provisions real environments and takes longer than the fast tests.

Run static checks

uv run ruff check
uv run ruff format --check
uv run mypy src/wetlands

Build documentation strictly

uv run --frozen --python 3.14 --extra docs --no-dev mkdocs build --strict

The strict build fails on invalid navigation, missing snippet files, and documentation warnings.

Build distribution artifacts

uv build

Understand the codebase

• How Wetlands works follows the main runtime flow.
• Architecture and execution protocol defines boundaries contributors must preserve.
• Transport codecs explains value encoding and shared-memory lease ownership.

Maintainers publishing a release must follow the canonical release checklist.