Download free

Code review

Ask for a quick review with /review or a deep one that verifies every finding, and fix what it found in one step.

Updated · version 2.0.145 · Markdown

NoBreiniers reviews your changes in two ways: a quick review, which is the usual one, and a deep one, which tries to refute every finding before it shows it to you.

Quick review

  1. In the message box type /review and send. Plain words work too: «review my changes».
  2. The chat's agent reviews your work on the branch since the place where it began (the app finds that place by itself and says in a note how it did) and answers in the chat. If it cannot tell where the branch began, it reviews the uncommitted changes and says so. It changes nothing.
You typeWhat it reviews
/reviewYour work on this branch since it began, committed or not.
/review uncommittedOnly this folder's uncommitted changes.
/review mainThe changes since that branch or version.
/review 12Pull request number 12.

The «Review» button in the «Changes» panel does the same.

Deep review

  1. Type /review deep. The same may follow it: /review deep main, /review deep 12.
  2. Under the chat the «Code review» bar shows what is going on: «Reviewing», then «Verifying … candidates».
  3. When it ends you see the verified findings, the most serious first.

What it does differently:

  • Several reviewers look at the change at once, each with a focus: bugs, security and your project's rules.
  • A second pass tries to refute each candidate: it reproduces it by running code, or traces it through the code and quotes the lines. If it cannot, the candidate is dropped.
  • You only see what was verified. The rest is counted as «… left out».

Each finding says:

FactValues
Severity«Important», «Minor» or «Pre-existing» (it was there before your change)
Confidence«high confidence», «medium confidence» or «low confidence»
How it was verified«Reproduced by running code» or «Traced by reading the code»

Fix the findings in one step

On the «Code review» bar:

ButtonWhat it does
«Show the findings»Opens or closes the list.
«Fix the important findings»Fixes only the important ones. The changes stay uncommitted, for you to look at.
«Post the findings on the PR»Leaves them as comments on the pull request.
«More review options»«Fix every finding», «Fix and push to the PR's branch» or «Fix on a new branch with its own PR».
«Stop the review»Cuts it short.

Before fixing, the app asks for your approval and says exactly what it will do. Afterwards each finding is in one of three states:

  • «Fixed: its check passes»: the finding's own check failed before the fix and passes after it.
  • «Changed, not checked»: it was changed, but the finding had no check to prove it.
  • «Not fixed».

Tune the review of a project

Create the file .nobreiniers/review.yaml in your repository:

KeyWhat it is for
effortHow wide the review looks: low uses a single reviewer; high adds one that looks at who calls the changed code.
rulesMore rule files the review must enforce, such as docs/review.md.
pathsinclude and exclude: which folders are reviewed.
autoopen and update: review a pull request by itself when it opens or when it is pushed to.
min_scoreFrom which score a finding is shown.
testThe command run after fixing, to catch a false fix.