Review fixes; README and CLAUDE.md finalised
- cancel reverts only the run's commits (base..HEAD), never the caller's edits - validator diffs base..HEAD, not the working tree - fix commits carry their Co-Authored-By line; no redundant end benchmark - score.py: clear error on a missing labels file; docstring says end is not passed - usage lines; README and CLAUDE.md for the generic workflow Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
0de006bcb2
commit
388619685a
10 files changed
+63
-30
No files matched your search
+1
-1
@@ -66,7 +66,7 @@ Your working folder is yours alone: `mktemp -d`. To try a variant without touchi
|
||||
|
||||
The validator can have a single fix removed without touching the others: each has its commit. For each fix, in order:
|
||||
1. change, then check as above, against the benchmark of the last committed state (the benchmark before, or that of your previous kept fix); before your output, the whole against the benchmark before; keep the output of the benchmark in `<output folder>/benchmark-S<n>.txt`;
|
||||
2. kept: `git -C <DETECTORS> add <the changed files> && git -C <DETECTORS> commit -m "wf-improve: S<n>" -- <the same>`, the message ending with an empty line then `Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>`;
|
||||
2. kept: `git -C <DETECTORS> add <the changed files> && git -C <DETECTORS> commit -m "wf-improve: S<n>" -m "Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>" -- <the same>`;
|
||||
3. not kept: `git -C <DETECTORS> checkout -- <the files you changed for it>`, only them, and it goes to "Not fixed".
|
||||
|
||||
Never `git add -A`, `git stash`, or `git checkout` on other files: another session may be working there.
|
||||
|
||||
+1
-1
@@ -17,7 +17,7 @@ The detectors repository (`DETECTORS`: the detectors `scripts/*.py`, `thresholds
|
||||
|
||||
- the range score before → after: the gain the modification sought;
|
||||
- in `modification.md`, the parts "What changed" and "Why", nothing else: `sed -n '/^## What changed/,/^## Before/p' <modification>`;
|
||||
- the diff of the detectors since the base: `git -C <DETECTORS> diff <base> -- 'scripts/*.py' thresholds.md`, and the code it touches; each fix has its commit (`git -C <DETECTORS> log --oneline <base>..HEAD`, message `wf-improve: S<n>`), its diff by `git -C <DETECTORS> show <commit>`;
|
||||
- the diff of the detectors since the base: `git -C <DETECTORS> diff <base> HEAD -- 'scripts/*.py' thresholds.md`, and the code it touches; each fix has its commit (`git -C <DETECTORS> log --oneline <base>..HEAD`, message `wf-improve: S<n>`), its diff by `git -C <DETECTORS> show <commit>`;
|
||||
- the benchmarks (the score per family on each station of the reference truth, then their `Total`), all stations in full; the benchmarks after each fix, in order, say which one makes a station go back; you may rerun the benchmark command;
|
||||
- to understand a regression on a station: the events command on its range (from the header of the station's block in the benchmark), with `2>&1`, at HEAD and, to compare, at the base (`git -C <DETECTORS> archive <base> | tar -x -C <folder>` in your working folder, then the same command with the copy's `scripts/categories.py`), the station's labels, and the families document.
|
||||
|
||||
|
||||
Reference in new issue
Block a user