Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 915 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 915 Bytes

Contributing

This document outlines a few tips for contributing to packse.

Getting started

packse uses uv's preview interface:

Install the project:

uv sync

Check that packse is available

uv run -- packse --help

Running tests

packse uses pytest:

uv run -- pytest

Updating snapshots

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.