Getting started

Reviewsaur takes about five minutes to set up. You connect a repository from inside the app, toggle it on, and — optionally — make the quiz a required check to enforce it.

1. Connect a repository

In your team dashboard, open Repositories and click Connect Repository (you'll also find this under Settings). That kicks off the GitHub app installation: pick the individual repos you want, or grant access to a whole organization, and confirm on GitHub.

GitHub sends you straight back to Reviewsaur, and the repositories it can access appear under Repositories — no separate sign-up step.

You only do the GitHub install once per organization. After that, connecting more repos is just a matter of granting access and toggling them on.

2. Toggle a repo on

On the Repositories page, toggle a repo on to make it active. From that moment, every new pull request on that repo automatically gets a quiz generated from its diff, and a link is posted on the PR.

On the Free plan you can keep one repository active at a time. Pro lifts that to unlimited — see Plans & limits.

3. (Optional) Make the quiz a required check

By default the quiz is advisory — it's generated and linked on every PR, but it doesn't stop anyone from merging. If you want to enforce comprehension, add “Reviewsaur Quiz” as a required status check in your repository's branch protection rules. Then GitHub won't let a PR merge until the quiz passes.

This step is entirely up to you — turn it on for the repos where you want a hard gate, and leave it off where you just want the quiz as a nudge.

Full walkthrough: GitHub status check.

What happens next

Open a pull request. Within a minute, Reviewsaur:

1. Reads the diff (skipping any excluded paths).
2. Generates a short quiz about what changed.
3. Posts a link on the PR and sets the Reviewsaur Quiz check to pending.

A reviewer opens the link, takes the quiz, and once they pass, the check turns green and the PR becomes mergeable. That's it.

Curious about the mechanics? See How it works.