Review notes docs tweaks
This commit is contained in:
@@ -28,8 +28,11 @@ Protocol:
|
||||
|
||||
1. Fetch prior results:
|
||||
`git fetch origin "refs/notes/review:refs/notes/review"`
|
||||
Ignore the failure on the first-ever review (origin has no notes ref yet);
|
||||
if the fetch is rejected as non-fast-forward, your local notes are ahead —
|
||||
push instead.
|
||||
2. Read the latest verdict and open findings for the branch:
|
||||
`scripts/review-note latest <branch>`
|
||||
`scripts/review-note latest [branch]`
|
||||
3. Review the branch tip per this document.
|
||||
4. Write the note (header + markdown) to a file and attach it to the tip:
|
||||
`scripts/review-note write <file>`. Use `--force` only to replace a note
|
||||
@@ -40,3 +43,7 @@ Protocol:
|
||||
On a re-review after fixes: new tip, new note, `round`+1, `previous` set to
|
||||
the last reviewed sha, open findings carried forward by ID, resolved ones
|
||||
marked `resolved`.
|
||||
|
||||
On a branch rename: update the note's `branch:` header to the new name and
|
||||
mention the old name in the body, so `latest <new-name>` chains and history
|
||||
stays findable.
|
||||
|
||||
@@ -102,10 +102,12 @@ becomes note round 1, with these findings:
|
||||
the rank-2 `Mealy` type; library does not compile.
|
||||
- F2 (blocker, test/AFRPLawsSpec.hs:98): seven law tests reduced to
|
||||
tautologies by hlint rewrites; see :103, :212, :221, :228, :235, :256.
|
||||
- F3 (minor, test/AFRPLawsSpec.hs:241): the interchange and composition laws
|
||||
were reshaped to `<$>` forms; fold them into the same hlint suppression.
|
||||
|
||||
## Verification
|
||||
|
||||
The script is verified by round-trip checks in a throwaway temp clone: write,
|
||||
show, latest (two rounds, branch filtering), force-overwrite refusal and
|
||||
acceptance, and push. No Haskell or cabal changes, so no
|
||||
cabal2nix regeneration.
|
||||
cabal2nix regeneration.
|
||||
|
||||
Reference in New Issue
Block a user