Repository navigation
fix(review): make review summaries and inline comments clearer - #28
Merged
Merged
Conversation
Clean approvals dumped a per-lens summary bullet for all four reviewers,
and change-requests repeated per-lens prose alongside jargon section
headers ("Lens failures", "Findings dropped (line not in PR diff
hunks)"), confusing readers with noise that wasn't actionable.
- Clean approval is now a single line plus a small "Checked:" footnote;
the per-lens summaries are gone.
- Change-requests lead with an issue count, point to the inline
comments, and show a category breakdown table instead of per-lens
prose. Operational problems (failed/blocked checks, off-diff findings)
appear in plain language only when they occur.
- Inline comment headers are now readable: "Bug, high confidence
(85/100)" with a category emoji, replacing "[bug / confidence 85]".
- Extract the shared display vocabulary (labels, emojis, confidence
wording, marker) into src/stages/review/format.ts.
The <!-- shopfloor-review --> marker stays the first body line so
check-review-skip's startsWith match keeps working.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Code review output was hard to read. Clean approvals dumped a per-lens summary bullet for all four reviewers even when there was nothing to act on, and change-requests repeated per-lens prose alongside jargon section headers (
Lens failures,Findings dropped (line not in PR diff hunks)). The signal that mattered (the inline comments) was buried in noise.What changed
Checked:footnote. The four per-lens summaries are gone.🐛 Bug · high confidence (85/100), replacing[bug / confidence 85].src/stages/review/format.ts.Notes
<!-- shopfloor-review -->marker stays the first body line socheck-review-skip'sstartsWithmatch keeps working.·middle-dots are intentional.Testing
pnpm test— 307 passedpnpm typecheck— cleanpnpm build— bundle rebuilt and committed