diff --git a/docs/handoffs/HANDOFF-rot.md b/docs/handoffs/HANDOFF-rot.md new file mode 100644 index 0000000..3dfe2e0 --- /dev/null +++ b/docs/handoffs/HANDOFF-rot.md @@ -0,0 +1,29 @@ +# The checks nobody runs + +Twice now a script in this repository has been quietly wrong for weeks. Both +times it was found by accident rather than by anything failing. This is the +inventory of everything in the tree that asserts something real and is not +reached by `dune test`, what each of them says today, and what was done about +the general problem. + +## The plan + +1. Sweep `spike/`, `web/`, `tools/`, `emacs/` and `test/` for anything that + checks something and is not on a dune alias. Run every one of them; record + pass or fail honestly rather than assuming. +2. Give `web/examples/check.sh` and `web/examples/quotes.sh` an opt-in alias in + the shape `@x86` already established, with the same kind of comment saying + why they are opt-in. +3. Decide what would actually have caught the two known failures within a day, + given that an opt-in alias is only marginally better than a script — both + require somebody to type them. + +## Red on arrival + +`web/examples/quotes.sh` fails, eleven checks of forty-odd. It is not +re-recorded to make it green: every one of its failures is a real statement on +`web/index.html` that has stopped being true, and three of them are the page +claiming a language feature is unimplemented when it now works. That is a +content decision for the author, written up below rather than papered over. + +(Details filled in as the work proceeds.)