Read PRRead PR
GitHubInstall on GitHub

Docs · Start here

Getting started

Two installs and one sign-in. The next pull request your team opens will gate on reading. Plan on about two minutes.

Read PR has two halves. The GitHub App posts the check on every pull request. The browser extension measures reading and reports it. Install both, in either order, and they meet on your next PR.

01

Sign in with GitHub.

Go to readpr.dev/auth/signin and sign in with your GitHub account. This is the identity the review log attributes reading to, so every reviewer on the team signs in with their own account.

02

Add the GitHub App.

Open github.com/apps/read-pr and press Install. Pick the organization, then choose All repositories or only the repos you want watched. You can change the list at any time from GitHub's installation settings.

GitHub's installation screen for the Read PR app with three repositories selected
Pick the repos Read PR watches. Selected repos get the check on their next pull request.

Installing creates a workspace at readpr.dev, registers the check run Read PR / Review complete, and starts a 14-day trial for private repos. Public repos are free, with no time limit.

03

Install the browser extension.

Every reviewer needs the extension. It is available for Chrome and Edge from the Chrome Web Store, for Firefox from Firefox Add-ons, and for Safari 16.4 and later on the App Store.

The Read PR extension listing with an Add to Chrome button
One click. The extension only runs on github.com pull request pages.

The extension asks for a single permission: storage. Its content script matches https://github.com/*/pull/* and nothing else. The source is public, so you can audit every byte it sends.

04

Connect the extension.

Click the Read PR icon in your browser toolbar. If this browser is signed in on readpr.dev, the extension mints its own token and reports Signed in as you. Nothing else to do.

The extension popup before and after connecting
Left: not yet connected. Right: connected and tracking on PR pages.
05

Read your first pull request.

Open any pull request on a watched repo and go to the Files changed tab. A progress ring sits beside each file header. Rings fill blue while you read and turn green when a file meets its threshold. Lockfiles and generated files are excluded by default and marked as such.

A GitHub pull request files view with Read PR progress rings beside each file
The files view with Read PR installed. Two files read, one in progress.

When every file is read, the check completes:

The Read PR check run showing All files read with per-reviewer timing
The check on the PR conversation page after the reading thresholds are met.
06

Make the check required. (Optional)

The check reports on every PR either way. To block merges until it passes, add it to branch protection:

  1. Repo Settings → Branches → your default branch rule.
  2. Enable Require status checks to pass and search for Read PR / Review complete.

Or from the command line:

gh api repos/:owner/:repo/branches/main/protection \
  --field 'required_status_checks.contexts[]=Read PR / Review complete'

Next