Skip to content

Commit 578ef8a

Browse files
authored
docs: HARNESS_PRIMER + INVARIANTS marker for route-versioning enforcement (#130, #132) (#76)
1 parent 4de2a07 commit 578ef8a

5 files changed

Lines changed: 382 additions & 3 deletions

File tree

docs/HARNESS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ The harness is independent of the project's domain. The included `src/api/echo`
3232

3333
## Reading order
3434

35+
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.
36+
37+
For an engineer setting up the template:
38+
3539
1. **`docs/INVARIANTS.md`** — the load-bearing rules. Every PR is checked against them.
3640
2. **`docs/BOUNDARIES.md`** — module layering and the import-linter contracts.
3741
3. **`docs/DEVELOPMENT.md`** — local setup, the `justfile`, the CI pipeline.

0 commit comments

Comments
 (0)