This document outlines a few tips for contributing to packse.
packse uses uv's preview interface:
Install the project:
uv sync
Check that packse is available
uv run -- packse --help
packse uses pytest:
uv run -- pytest
If you make changes to the code that results in a snapshot test failing, then
you should examine whether the changes are correct. If so, you can re-run the
tests with the --snapshot-update flag:
uv run -- pytest --snapshot-update
And then commit the results. In at least some cases, this may commit a snapshot that is inconsistent with what CI expects. In this case, you'll want to manually back out the change. See this comment for an example.
This step requires NodeJS installed.
npm install
npx prettier --write "scenarios/**/*.{toml,json,yaml}"