Skip to main content

​
What starts a review?

For a repository with reviews switched on, Rapid Review reviews a pull request when it is:
  • opened;
  • pushed to (each new head commit);
  • reopened;
  • marked ready for review;
  • moved to a different base branch.

​
Are draft pull requests reviewed?

No. Rapid Review doesn’t review draft or closed pull requests. A draft is reviewed once it’s marked ready for review. Closing a pull request stops a review that is running.

​
What happens if I push while a review is running?

Each push gets its own rapid-review check. If you push again while a review is running, that review stops and the newer push is reviewed instead. Parts of the change that an earlier review of the same pull request already reviewed, unchanged and in the same mode, aren’t reviewed again. Their earlier findings are carried over, and the check notes how many parts (“units”) were unchanged.

​
How do I ask Rapid Review to review a pull request?

There are two ways to ask for a review of the pull request’s current head commit:
  • Comment @rapidreview-dev review in the pull request’s conversation, as the whole comment.
  • Re-run the rapid-review check on GitHub.
Rapid Review reviews the head when no finished review has read it. This works in every repository, for example after a review failed. Only comments from the repository’s owners, members and collaborators count. Rapid Review reacts once to a comment that asks for a review:
  • Thumbs up: the review is queued.
  • Eyes: there’s nothing to review. That head was already reviewed, or the pull request is closed or a draft.
  • Confused: Rapid Review couldn’t read the pull request.
A comment that names another app, or comes from someone whose comments don’t count, gets no reaction.

​
What does “Not reviewed: later pushes on request” mean?

The repository is set to review each pull request once by itself, when it’s opened or marked ready for review, and later pushes only when someone asks. A push that isn’t reviewed gets a skipped check titled “Not reviewed: later pushes on request”. Its summary says how to ask: comment @rapidreview-dev review on the pull request, or re-run the check. The summary comment on the pull request names the command too. If someone pushes while a requested review runs, the newer head is reviewed instead.

​
What does “Waiting for the description” mean?

Some repositories have the review of a later push wait for the pull request’s description. Coding agents often push first and update the description after, and the review reads the title and description as it starts. While it waits, the push’s check is in progress with the title “Waiting for the description”. The review starts:
  • once the title or description, edited after the push, has gone 10 seconds without another edit;
  • at once, when someone comments @rapidreview-dev review or re-runs the check;
  • 90 seconds after the push at the latest.
A newer push starts the wait again, and the older push’s check is cancelled with “Stopped before the review started”. The first review of a pull request never waits.