Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 999 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 999 Bytes
Raw

Contributing

All configuration for the project should be put into pyproject.toml.

Working locally

  1. Create a virtualenv using whatever method you like ( eg, virtualenvwrapper)

  2. Install dependencies from requirements.txt

Updating/adding a dependency

  1. Add or update the dependency in pyproject.toml

  2. Update constraints file

uv pip compile --all-extras pyproject.toml --output-file constraints.txt -U

Pre-commit

Basic checks (formatting, import order) is done with pre-commit and is controlled by the yaml file.

After installing dependencies, Run

# check it works
pre-commit run --all-files
pre-commit install

Run every so often to update the pre-commit hooks

pre-commit autoupdate

Fixing Python formatting issue

ruff format tavern/ tests/
ruff --fix tavern/ tests/

Fix yaml formatting issues

pre-commit run --all-files