1. Install the GitHub App
- Install Codzee on GitHub on your account or organization.
- Choose Only select repositories and pick the repos Codzee should review, or choose all repositories. You can change the list later from the same GitHub page.
- Sign in to the dashboard with GitHub. It lists the repos Codzee can review.
2. Reviews run on their own
Once a repo is connected, there is nothing to run. Codzee reviews a pull request when it is opened or reopened, and again on every push to it. A review after a push covers the new commits, so comments already made aren’t repeated.
3. Ask for a review with @codzee review
Pull requests opened before you installed Codzee haven’t been reviewed. To review one, or to ask for a full fresh review of any PR, comment on it:
@codzee review4. Read the check and the severities
Each review adds a Codzee review check to the PR, with a summary of what was found. The check passes when the review completes. It fails when the PR breaks a Blocking review rule, and is neutral when a review couldn’t finish.
Every comment is labelled with a category (bug, security, performance, style) and a severity:
| Severity | What it means |
|---|---|
| Critical | Loses or miscounts money, exposes or corrupts another user's data, lets a caller get past authentication or authorization, or corrupts stored state. Fix before merging. |
| Major | Wrong behaviour a user will hit on a normal path, a race under ordinary load, or a test that hides a real bug. Worth fixing in this PR. |
| Minor | Edge cases, robustness, misleading names, clarity. Worth fixing, not worth blocking a merge. |
To block merging on Codzee’s findings, make the check required in your branch protection rules on GitHub. An admin can also set the check to fail when a review finds a Critical issue, in the review settings.
5. Settings
| Setting | What it does |
|---|---|
| Review rules | Your team's conventions in plain English. Codzee checks every PR against them, and a Blocking rule fails the check. |
| Reviewer routing | Who Codzee suggests as reviewers for a PR, based on who knows the changed code. |
| Review behavior | How Codzee reviews: what it comments on and how much. Each repo can override it from its own settings. |
More on writing rules: Review rules.