Get the FREE Ultimate OpenClaw Setup Guide →

review-verification-protocol

Scanned
npx machina-cli add skill existential-birds/beagle/review-verification-protocol --openclaw
Files (1)
SKILL.md
8.2 KB

Review Verification Protocol

This protocol MUST be followed before reporting any code review finding. Skipping these steps leads to false positives that waste developer time and erode trust in reviews.

Pre-Report Verification Checklist

Before flagging ANY issue, verify:

  • I read the actual code - Not just the diff context, but the full function/class
  • I searched for usages - Before claiming "unused", searched all references
  • I checked surrounding code - The issue may be handled elsewhere (guards, earlier checks)
  • I verified syntax against current docs - Framework syntax evolves (Tailwind v4, TS 5.x, React 19)
  • I distinguished "wrong" from "different style" - Both approaches may be valid
  • I considered intentional design - Checked comments, CLAUDE.md, architectural context

Verification by Issue Type

"Unused Variable/Function"

Before flagging, you MUST:

  1. Search for ALL references in the codebase (grep/find)
  2. Check if it's exported and used by external consumers
  3. Check if it's used via reflection, decorators, or dynamic dispatch
  4. Verify it's not a callback passed to a framework

Common false positives:

  • State setters in React (may trigger re-renders even if value appears unused)
  • Variables used in templates/JSX
  • Exports used by consuming packages

"Missing Validation/Error Handling"

Before flagging, you MUST:

  1. Check if validation exists at a higher level (caller, middleware, route handler)
  2. Check if the framework provides validation (Pydantic, Zod, TypeScript)
  3. Verify the "missing" check isn't present in a different form

Common false positives:

  • Framework already validates (FastAPI + Pydantic, React Hook Form)
  • Parent component validates before passing props
  • Error boundary catches at higher level

"Type Assertion/Unsafe Cast"

Before flagging, you MUST:

  1. Confirm it's actually an assertion, not an annotation
  2. Check if the type is narrowed by runtime checks before the point
  3. Verify if framework guarantees the type (loader data, form data)

Valid patterns often flagged incorrectly:

// Type annotation, NOT assertion
const data: UserData = await loader()

// Type narrowing makes this safe
if (isUser(data)) {
  data.name  // TypeScript knows this is User
}

"Potential Memory Leak/Race Condition"

Before flagging, you MUST:

  1. Verify cleanup function is actually missing (not just in a different location)
  2. Check if AbortController signal is checked after awaits
  3. Confirm the component can actually unmount during the async operation

Common false positives:

  • Cleanup exists in useEffect return
  • Signal is checked (code reviewer missed it)
  • Operation completes before unmount is possible

"Performance Issue"

Before flagging, you MUST:

  1. Confirm the code runs frequently enough to matter (render vs click handler)
  2. Verify the optimization would have measurable impact
  3. Check if the framework already optimizes this (React compiler, memoization)

Do NOT flag:

  • Functions created in click handlers (runs once per click)
  • Array methods on small arrays (< 100 items)
  • Object creation in event handlers

Severity Calibration

Critical (Block Merge)

ONLY use for:

  • Security vulnerabilities (injection, auth bypass, data exposure)
  • Data corruption bugs
  • Crash-causing bugs in happy path
  • Breaking changes to public APIs

Major (Should Fix)

Use for:

  • Logic bugs that affect functionality
  • Missing error handling that causes poor UX
  • Performance issues with measurable impact
  • Accessibility violations

Minor (Consider Fixing)

Use for:

  • Code clarity improvements
  • Documentation gaps
  • Inconsistent style (within reason)
  • Non-critical test coverage gaps

Informational (No Action Required)

Use for:

  • Improvements that require adding new dependencies or modules
  • Suggestions for net-new code that didn't exist in the codebase before (new modules, test suites, abstractions)
  • Architectural ideas for future consideration
  • Test infrastructure suggestions (new mock libraries, behaviour extraction)
  • Optimizations without measurable impact in the current context

These are NOT review blockers. They should be noted for the author's awareness but must not appear in the actionable issue count. The Verdict should ignore informational items entirely.

Do NOT Flag At All

  • Style preferences where both approaches are valid
  • Optimizations with no measurable benefit
  • Test code not meeting production standards (intentionally simpler)
  • Library/framework internal code (shadcn components, generated code)
  • Hypothetical issues that require unlikely conditions

Valid Patterns (Do NOT Flag)

TypeScript

PatternWhy It's Valid
map.get(key) || []Map.get() returns T | undefined, fallback is correct
Class exports without separate type exportClasses work as both value and type
as const on literal arraysCreates readonly tuple types
Type annotation on variable declarationNot a type assertion
satisfies instead of asType checking without assertion

React

PatternWhy It's Valid
Array index as key (static list)Valid when: items don't reorder, list is static, no item identity needed
Inline arrow in onClickValid for non-performance-critical handlers (runs once per click)
State that appears unusedMay be set via refs, external callbacks, or triggers re-renders
Empty dependency array with refsRefs are stable, don't need to be dependencies
Non-null assertion after checkTypeScript narrowing may not track through all patterns

Testing

PatternWhy It's Valid
toHaveTextContent without regexHandles nested text correctly
Mock at module levelDefined once, not duplicated
Index-based test dataTests don't need stable identity
Simplified error messagesTest clarity over production polish

General

PatternWhy It's Valid
+? lazy quantifier in regexPrevents over-matching, correct for many patterns
Direct string concatenationSimpler than template literals for simple cases
Multiple returns in functionCan improve readability
Comments explaining "why"Better than no comments

Context-Sensitive Rules

React Keys

Flag array index as key ONLY IF ALL of these are true:

  • Items CAN be reordered (sortable list, drag-drop)
  • Items CAN be inserted/removed from middle
  • Items HAVE stable identifiers available (id, uuid)
  • The list is NOT completely replaced atomically

useEffect Dependencies

Flag missing dependency ONLY IF:

  • The value actually changes during component lifetime
  • Stale closure would cause incorrect behavior
  • The value is NOT a ref (refs are stable)
  • The value is NOT a stable callback (useCallback with empty deps)

Error Handling

Flag missing try/catch ONLY IF:

  • No error boundary catches this at a higher level
  • The framework doesn't handle errors (loader errorElement)
  • The error would cause a crash, not just a failed operation
  • User needs specific feedback for this error type

Before Submitting Review

Final verification:

  1. Re-read each finding and ask: "Did I verify this is actually an issue?"
  2. For each finding, can you point to the specific line that proves the issue exists?
  3. Would a domain expert agree this is a problem, or is it a style preference?
  4. Does fixing this provide real value, or is it busywork?
  5. Format every finding as: [FILE:LINE] ISSUE_TITLE
  6. For each finding, ask: "Does this fix existing code, or does it request entirely new code that didn't exist before?" If the latter, downgrade to Informational.
  7. If this is a re-review: ONLY verify previous fixes. Do not introduce new findings.

If uncertain about any finding, either:

  • Remove it from the review
  • Mark it as a question rather than an issue
  • Verify by reading more code context

Source

git clone https://github.com/existential-birds/beagle/blob/main/plugins/beagle-core/skills/review-verification-protocol/SKILL.mdView on GitHub

Overview

This protocol must be followed before reporting any code review finding. It provides a structured Pre-Report Verification Checklist and issue-type guidance to minimize false positives, save developer time, and preserve trust in reviews.

How This Skill Works

Before flagging an issue, you complete the Pre-Report Verification Checklist that covers reading the full code, searching for all usages, checking surrounding code, verifying syntax against current docs, distinguishing wrong from different style, and considering intentional design. Then you apply the issue-type verification guidance for common categories like Unused Variable/Function, Missing Validation, Type Assertion, Potential Memory Leak, and Performance Issues, ensuring you report only after thorough verification.

When to Use It

  • Flagging an Unused Variable/Function only after exhaustive search of references, exports, and dynamic usage
  • Questioning Missing Validation or Error Handling only after checking higher level validation and framework features
  • Raising a Type Assertion/Unsafe Cast after confirming it is actually an assertion and runtime checks narrow the type
  • Identifying a Potential Memory Leak or Race Condition only after confirming cleanup is missing and unmount is possible
  • Flagging a Performance Issue only if the issue recurs frequently and shows measurable impact beyond existing optimizations

Quick Start

  1. Step 1: Load the Review Verification Protocol before reporting any findings.
  2. Step 2: Run the Pre-Report Verification Checklist and verify each item for your context.
  3. Step 3: Apply the issue type checks and finalize your report only after all steps

Best Practices

  • Read the full function or class, not just the diff context
  • Search for all references in the codebase
  • Check surrounding code for guards or prior checks
  • Verify syntax against current docs and framework versions
  • Distinguish wrong from different style and consider intentional design and context

Example Use Cases

  • A React state setter is flagged as unused but triggers re-renders and is intentionally used
  • Missing validation flagged but FastAPI + Pydantic validate input at the API boundary
  • A TypeScript assertion is flagged but runtime narrowing and framework guarantees apply
  • Potential memory leak flagged while cleanup exists elsewhere or unmount is safe
  • Performance concern flagged for a tiny operation with negligible or unmeasured impact

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers