Documentation Review changes

Review changes

Read findings as evidence for your review decision.

Every returned finding identifies a supplied location, material risk, concise explanation, and practical fix direction.

Finding shape

FieldTypeDescription
filePath RequiredstringRepository-relative path from the submitted diff.
lineNumber RequiredintegerOne-based line anchor for the finding.
lineSide RequiredNEW | OLDWhether the anchor belongs to the new or old side of the diff.
oldLineNumber Optionalinteger | nullOptional one-based anchor on the old side of the diff; null when no corresponding original line is available.
hunkHeader Optionalstring | nullOptional unified-diff hunk header for the finding's location; null when unavailable.
priority RequiredP0 | P1 | P2Materiality level returned by the review policy.
category RequiredenumLOGIC_BUG, RACE_CONDITION, SECURITY, PERFORMANCE, or RELIABILITY.
summary RequiredstringConcise explanation of the defect and its reachable impact.
suggestedFix RequiredstringPractical remediation direction that still requires engineering review.

Priority rubric

  • P0 — exploitable security flaw, credential exposure, irreversible data loss, or broad production outage.
  • P1 — definite reachable bug causing data corruption, authorization bypass, severe reliability failure, or major performance collapse.
  • P2 — concrete reachable defect with plausible user, security, correctness, or production impact.

Style, naming, formatting, minor cleanup, and low-confidence speculation are not returned as findings.

When no findings are returned

No qualifying finding is not proof of safety

An empty findings array means the review returned no issue meeting its configured threshold for the supplied evidence. Continue with tests, human review, and your normal release controls.