Docs
Your first 5 minutes with VeriFlow
A four-step first-review walkthrough — connect GitHub with OAuth, select a repository, and drop a review.yml on the default branch, open a pull request, and read the review that comes back.
1 — Connect GitHub
Open /onboarding and choose Continue with GitHub. Authorize the repo and admin:repo_hook scopes, then select one or more repositories and install their webhooks.
See the full GitHub connection guide for the permission scopes, repository selection toggles, and post-install verification steps.
2 — Add a review.yml
Drop the minimum viable config into .github/review.yml on the default branch and commit. The file is reloaded on every PR open, so the moment it lands, the next pull request is reviewed automatically — no additional repository setup is required.
version: 1
For the full key reference, the annotated sample, and per-language overrides, see the review.yml configuration reference.
3 — Open a pull request
Open a PR — or move one out of draft — on a repo you connected in step 1. The pull_request event fires, VeriFlow picks up the diff at the PR head SHA, and VeriFlow processes the supported pull request delivery for the connected repository.
If nothing arrives, confirm the repository was selected and its webhook was installed — go back to the GitHub connection guide and run through the post-install verification list.
Where to next
You’ve now seen the full first-review loop end-to-end. Once you’re ready to tune the per-repo behaviour — depth, paths, ignore patterns, inline comment volume, per-language overrides — go deeper with the review.yml configuration reference.
Re-run everything above for a different repository — the GitHub connection guide covers the OAuth scopes, repository selection, webhook installation, and connection verification.
Catch the same review before the PR is even opened by running VeriFlow against the staged set on every commit — the pre-commit hook guide has the copy-ready setup for both husky and the pre-commit framework.
4 — Read the review that comes back
The review shows up on the PR in two parts: a file-level summary at the top of the review body, and a small number of inline comments on the lines that earned them. Volume is bounded by comments.per_file and comments.per_review from your review.yml — sensible defaults ship out of the box, so the first review reads as thorough but not noisy.
Tighten or relax the cap on a per-repo basis via the review.yml reference, or wire VeriFlow into pre-commit so the same review runs against your staged set before the PR even exists — see the pre-commit hook guide.