From 1385452dc9d15f04eb6e894813920c1839ec332a Mon Sep 17 00:00:00 2001 From: jochen Date: Fri, 23 Oct 2026 15:11:20 +0200 Subject: [PATCH] Say in the checks' README that the same four checks are Go tests (issue 1296) --- 00-META/checks/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/00-META/checks/README.md b/00-META/checks/README.md index 51a58718..69716711 100644 --- a/00-META/checks/README.md +++ b/00-META/checks/README.md @@ -1,5 +1,10 @@ # Checks +Since ADR 0527 the same four checks are also Go tests, in this folder (`*_test.go`) with `go.mod` at the root: run +`go test ./...` from the root. Each check is a function over a file tree that returns its problems, tested on hq's tree +and on a deliberately broken tree built in memory. The Python files and `merge-check.sh` run beside them until the +delivery of R4g is done and hq's trunk requires `mesh/check` (ADR 0527 ยง3); then they go (issue 1296). + ``` python3 00-META/checks/records.py structure: links, no record written here, citations in the form "ADR NNNN" python3 00-META/checks/index.py the reading order's topics are written, and no list of records is stored