Skip to content

docs: HARNESS_PRIMER + INVARIANTS marker for route-versioning enforcement #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
constk merged 1 commit into from
May 2, 2026
Merged

docs: HARNESS_PRIMER + INVARIANTS marker for route-versioning enforcement #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/HARNESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ The harness is independent of the project's domain. The included `src/api/echo`

## Reading order

For someone who hasn't worked in a harness like this before, start with [`docs/HARNESS_PRIMER.md`](HARNESS_PRIMER.md) — it's the same surface as this doc but written for non-engineers.

For an engineer setting up the template:

1. **`docs/INVARIANTS.md`** — the load-bearing rules. Every PR is checked against them.
2. **`docs/BOUNDARIES.md`** — module layering and the import-linter contracts.
3. **`docs/DEVELOPMENT.md`** — local setup, the `justfile`, the CI pipeline.
Expand Down
Loading
Loading