Skip to main content

​
What review modes are there?

Each repository is reviewed in one mode. You can choose between two:
  • Budget: the reviewer is shown the changed lines with the code around them, and some related code from the repository.
  • Standard: the reviewer is shown whole changed files (for a large file, the parts the change touches), more related code from the rest of the repository, and the repository’s learnings. Parts of a change that add only a few lines are reviewed the way budget mode reviews them.
Public repositories can also be in the free tier, which Rapid Review sets up.

​
Which mode does my repository use?

A repository is reviewed in standard mode unless another mode is set for it. Each review’s check says which mode it ran in, on its “Mode:” line.

​
How do I change a repository’s mode?

Set mode in the repository’s .rapid-review.yml:
mode accepts budget or standard. The file is read as it is where the pull request’s branch left the base branch. A pull request that edits the file is reviewed under the earlier version, and the change applies to later pull requests once it’s merged. The file’s mode isn’t used when the repository is in the free tier, or when Rapid Review has set the repository’s mode to take precedence over its file. The check’s warnings then say that the file’s mode wasn’t used.

​
What happened to the deep mode?

The deep mode has been retired. A .rapid-review.yml that still says mode: deep is reviewed in the repository’s default mode, and the check’s warnings say so. To pick a mode yourself, set mode: budget or mode: standard.

​
Is the free tier a review mode?

The free tier is Rapid Review’s tier for open-source repositories, at fair-use rates, and only for public repositories. Rapid Review puts a repository in it; it can’t be chosen in .rapid-review.yml. A repository in the free tier is reviewed in it whatever its .rapid-review.yml says, and the check’s warnings name the file’s mode.