Quickstart on GitHub.com

Sourcery reviews every pull request on the repos you connect. Set it up in a few minutes: install the GitHub app, pick your repos, and open a pull request to read your first review.

Before you start

Required permissions

You install Sourcery as a GitHub app. Installing an app on an organization is an owner-level action, so you need owner permissions on that organization. For a personal account, you already have everything you need.

Install Sourcery

1. Log in with GitHub

   Go to the Sourcery dashboard and click Log in with GitHub. The first time you log in, Sourcery sends you straight to GitHub to install the app.

2. Choose where Sourcery runs

   Pick the organization or personal account where you want reviews. If you belong to several organizations, just pick one to start; you can connect the others later.

3. Set access and authorize

   Choose which repositories Sourcery can reach, then review the permissions it requests.

   Repository access

   You have two options here. All repositories covers everything in the organization, now and in the future. Only select repositories limits Sourcery to the repos you pick. We recommend all repositories for most teams: new repos get reviews automatically, and you can always narrow the selection later.

   Permissions

   Read-only access

   metadata, organization members, and email addresses

   Read and write access

   actions, checks, code, commit statuses, issues, pull requests, and workflows

   Your code stays yours

   Write access lets Sourcery post reviews, set the status check, and apply suggested fixes. We don’t retain your source code after a review. See Code retention for the detail your security team will want.

   Click Install & Authorize. GitHub sends you back to Sourcery.

4. Choose what to scan

   Sourcery asks which repositories to scan for security issues and pre-selects your most recently updated ones. Pick the repos you want covered and click Start. That’s it for setup: the security dashboard opens, and code review is already running on every pull request.

Already using Sourcery?

To add another organization later, click your account name at the top of the sidebar to open the account switcher, then click Connect GitHub organization.

Your first review

Now for the good part. Open a pull request on any connected repo. Sourcery reviews the change, and you’ll see:

• A summary in the pull request description covering the change’s purpose and risk.
• A reviewer’s guide comment with the code paths that changed and how to verify them.
• Inline comments on the specific lines they’re about.
• A status check called Sourcery review next to the merge button.

On your first review, Sourcery also posts a tips and commands comment that lists the chat commands and configuration available. It’s handy while you learn the commands; once you don’t need it, turn off Enable tips and commands in Configure code reviews.

What’s next

Anatomy of a review Walk through one Sourcery review from top to bottom.

Commands Talk to Sourcery from pull request comments using @sourcery-ai.

Configure code reviews Adjust Sourcery's review behavior per repo or per organization.