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
| What | Where to Look |
|---|---|
| Merge box | PR page → Conversation tab → merge box at the bottom, with the check's one-line verdict |
| Check | PR page → Checks tab → "RubberDuck review" |
| Review comment | PR 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:
| Section | What It Shows |
|---|---|
| This PR | What 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 introduces | A table of new findings with their severity, finding name (e.g. SQL_INJECTION), file and line, and whether each one is verified |
| Missing updates | Places outside the PR that still use a changed function the old way |
| Design & maintainability | Suggestions. They never fail the check |
| Custom rules | Violations of the repo's .rubberduck.yml rules, detailed in the review comment |
| Why this check is red | The reason the check failed, when it did |
| Existing findings | How many findings were already in the repo before this PR. They are not counted against it; @rubberduck existing lists them |
| Next | A 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:
| Section | What It Shows |
|---|---|
| Understand this change | What the PR does in plain words, a diagram of what changed, and the files outside the PR that use it |
| Correctness & security | Each 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 & maintainability | Suggestions 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 |
| Validation | Changed code that has no tests yet |
| Custom rules | Violations 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:
| Status | Meaning |
|---|---|
| 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.