Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (43 loc) · 918 Bytes

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 918 Bytes

Contributing

Requirements

  • Python 3.10 or newer
  • uv for dependency management

Setup

Clone the repository and install all dependencies including dev tools:

git clone https://github.com/openfaas/python-sdk
cd python-sdk
uv sync

Running tests

uv run pytest tests/

Linting

Check for lint issues:

uv run ruff check .

Fix lint issues automatically:

uv run ruff check --fix .

Formatting

Check formatting:

uv run ruff format --check .

Apply formatting:

uv run ruff format .

Type checking

uv run pyright

CI

All of the above are run automatically on every push and pull request via GitHub Actions. The workflow runs:

  • Lint — ruff check and ruff format --check
  • Type check — pyright
  • Test — pytest across Python 3.10, 3.11, 3.12, and 3.13