Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion AUTHORING.md
Original file line number Diff line number Diff line change
Expand Up @@ -1450,16 +1450,30 @@ This project uses [uv](https://docs.astral.sh/uv/) for dependency management:
# Install dependencies for the entire workspace
uv sync --all-packages

# Run all tests and type/code quality checks
# Run the tests affected by your changes, plus type/code quality checks
make check

# Run every test, regardless of what changed
make test-all

# Run tests for a specific package
uv run pytest packages/overture-schema-theme-buildings/

# Run tests matching a pattern
uv run pytest -k "buildings"
```

`make check` and `make test` select tests with
[pytest-testmon](https://testmon.org/). Testmon records which code each test ran (in
`.testmondata`) and runs only the tests whose code has changed since they last passed. Its
record is independent of git: an uncommitted edit that an earlier run already tested
counts as clean. So when `make check` prints `no tests ran` and exits 0, every test that
touches the current code has passed against it. The suite wasn't skipped.

Testmon tracks Python code, not data. A change to a golden baseline file or to the
`[[examples.<Model>]]` tables in a theme's `pyproject.toml` selects no tests, so run
`make test-all` after one.

Auto-format / fix code to align with project expectations:

```shell
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ These pages are for people working with the packages in code:
- [GLOSSARY.md](GLOSSARY.md) — vocabulary for both the data model (entity, feature type,
theme) and the Python toolchain (entry point, workspace, discriminated union).

Run the full test and quality suite with:
Run the tests affected by your changes, plus the quality checks, with:

```bash
make check
Expand Down
Loading