Skip to content

contributing_tldr.md

Latest commit

 

History

History
39 lines (26 loc) · 893 Bytes

contributing_tldr.md

File metadata and controls

39 lines (26 loc) · 893 Bytes

Contributing TL;DR

Feel free to send a PR to update this file if you find anything useful. 🙇

Environment

  • Python >=3.10
  • uv >=0.9.0

Useful commands

Please check the pyproject.toml for a comprehensive list of commands.

Code Changes

# Ensure you have the correct dependencies
uv sync --dev --frozen

# Make ruff happy
uv run poe format

# Check if ruff and ty are happy
uv run poe lint

# Check ty against Python 3.10 types (matches [tool.ty.environment] python-version)
uv run ty check --python-version 3.10

# Run tests in parallel.
pytest -n auto # This may take a while.
pytest -n auto <test_suite>

Documentation Changes

# Build the documentation locally and check for broken links
uv run poe doc