58 lines
2.6 KiB
Markdown
58 lines
2.6 KiB
Markdown
# PR#99: The README and the diagrams describe the current review
|
|
|
|
> **WARNING:** This document describes only the change applied in this PR.
|
|
> It may already be outdated once the next PR is merged.
|
|
> Historic PR documentation is not maintained along with new PRs; treat it as a snapshot.
|
|
|
|
## Problem
|
|
|
|
A check of the README and the diagrams against the code of 0.40.0 found these differences:
|
|
|
|
- The README names a PR of mechanical changes as the only GREEN without a complete model review.
|
|
The code also allows it for images only, a carried-over approval, Jev's judgment of every file,
|
|
and a PR of documentation only in classifier mode.
|
|
- The steps of a run lack the WIP check, the carry-over of an approval and the escalation after `max_red_rounds`;
|
|
the last step names only the comment, the status and the usage line.
|
|
- The README counts 11 steps, the inside diagram 10 other ones.
|
|
- The decisions diagram asks for a secret after the shortcut of mechanical, image or approved changes;
|
|
the code checks the secret first, and the green box of the shortcut hides that the rules still decide.
|
|
- The README, the Mermaid chart and two diagrams say that the model advises;
|
|
only a host with `[engine] model_role = "advises"` makes it so.
|
|
- The PR workflow diagram gives "about 2 minutes" per review; reviews take 2 to 6 minutes.
|
|
It has no arrow from a requested change to the rework, and it does not show the carry-over of an approval.
|
|
- "Status: v0.1, trial." is outdated.
|
|
|
|
## Non-Goals
|
|
|
|
- No change of the code of a review.
|
|
- No new diagram.
|
|
|
|
## Solution
|
|
|
|
- The README lists the four cases of a GREEN without a complete model review.
|
|
- The steps of a run follow the 10 steps of the inside diagram;
|
|
step 1 holds the WIP check, the reuse of a result and the search for an approval to carry over,
|
|
step 2 the secret scan and the shortcut, step 10 the escalation and every write to Gitea.
|
|
- The decisions diagram asks for a secret before the shortcut; the shortcut ends in "Verdict of the rules alone",
|
|
and a new decision shows the escalation after `max_red_rounds`.
|
|
- The Mermaid chart no longer says that the model advises;
|
|
the inside diagram and the PR workflow diagram say "advises or decides",
|
|
and the inside diagram names no model of a host in its steps.
|
|
- The PR workflow diagram gives 2 to 6 minutes, names the images, the carry-over of an approval,
|
|
and has an arrow from a requested change back to the rework.
|
|
- The status line names the use on git.javagil.de.
|
|
|
|
The Mermaid chart stays: it shows which result goes where, which the three diagrams do not.
|
|
|
|
## Additional Changes
|
|
|
|
- The plan sets the image rules of PR#98 to deployed.
|
|
|
|
## Open Questions
|
|
|
|
None.
|
|
|
|
## Follow-up PRs
|
|
|
|
None.
|