Skip to content
Merged
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
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

## Unreleased

Nothing yet.
### Documentation

- The README is rewritten in plain English with the headings, the order and the terms that
every guideme SDK now shares. Design rationale and measurements it carried are in
`docs/design.md`, and the contributor notes are in `CONTRIBUTING.md`. The TypeScript SDK is
listed under **Other SDKs**. No behaviour changes.

## 0.2.0 — 2026-09-22

Expand Down
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

guideme makes a TypeSafe Jev judgment usable as Python control flow. It is one distribution,
`guideme`. Its public surface is what `src/guideme/__init__.py` exports, plus a second
supported tier that callers import by their own path: the modules `guideme.api` and
`guideme.policy`, and the single name `guideme.question.Question`.
supported tier that callers import by their own path: the modules `guideme.api`,
`guideme.api.client` and `guideme.policy`.
Everything else in the package is private. `AGENTS.md` and the README's **Lower layers**
section say what each tier promises.

Expand Down Expand Up @@ -38,6 +38,9 @@ mise run test # while you work
mise run check # the full gate; the pre-push hook runs it too
```

A source distribution carries the tests but not `mise.toml` or `uv.lock`, so from one rather
than a clone, run the suite with `uv run --group dev pytest`.

The suite is small on purpose and `AGENTS.md` says what a new test may be. A pull request that
adds a mock of `policy`, of `Guide` or of the transport will be asked to replace it with a real
local server, a property test, or a typing proof.
Expand Down
Loading
Loading