Reading Your Results

Every review lands where you already look on GitHub: the RubberDuck review check on the PR's latest commit, which also shows in the merge box, and a review comment on the PR. Here's what each one shows and where to find it.

Where to find results

WhatWhere to Look
Merge boxPR page → Conversation tab → merge box at the bottom, with the check's one-line verdict
CheckPR page → Checks tab → "RubberDuck review"
Review commentPR page → Conversation tab → RubberDuck's review comment

The RubberDuck review check

The check opens with a one-line verdict, for example "1 critical + 1 high-severity security issues to resolve before merge, and 1 call that will break", followed by the repo's overall grade and score. Its Details break down as follows:

SectionWhat It Shows
This PRWhat changed: functions and files changed, routes reached, files outside the PR that use what changed, findings introduced, calls that will break, and changed functions with no test calls
Findings this PR introducesA table of new findings with their severity, finding name (e.g. SQL_INJECTION), file and line, and whether each one is verified
Missing updatesPlaces outside the PR that still use a changed function the old way
Design & maintainabilitySuggestions. They never fail the check
Custom rulesViolations of the repo's .rubberduck.yml rules, detailed in the review comment
Why this check is redThe reason the check failed, when it did
Existing findingsHow many findings were already in the repo before this PR. They are not counted against it; @rubberduck existing lists them
NextA link to the review comment, and the commands to reply with under a finding

The review comment

RubberDuck posts one review comment on the PR and updates it when new commits are pushed. It has these sections:

SectionWhat It Shows
Understand this changeWhat the PR does in plain words, a diagram of what changed, and the files outside the PR that use it
Correctness & securityEach finding with its trigger, cause, consequence, evidence and fix. Security findings include a data-flow chart showing how user input reaches the risky call. A verified badge means RubberDuck re-checked the finding and confirmed it
Design & maintainabilitySuggestions such as moved or duplicated code, each with a ready-made "Ask RubberDuck" prompt for the RubberDuck chat or your IDE. Suggestions only; they don't change the verdict
ValidationChanged code that has no tests yet
Custom rulesViolations of the repo's .rubberduck.yml rules, when the repo has one

RubberDuck also comments on the code lines where it found a problem. Reply under one of those comments with @rubberduck explain, verify or fix to act on that finding.

Check status

What the check status means:

StatusMeaning
In progress (yellow)The review is still running
Success (green)The PR adds no critical or high-severity security issue
Failure (red)The PR adds a critical or high-severity security issue. Missing updates and design items are listed but do not fail the check

GitHub's Re-run checks on the RubberDuck review check starts a fresh review, as does @rubberduck review.