Quick start

Install OpenMerge#

You need a GitHub account with permission to install apps on the repositories you want reviewed.

1. 1

   Sign in with GitHub

   Click Get started on the OpenMerge home page and authorize with your GitHub account.
2. 2

   Install the GitHub App

   Choose the account or organization, then pick Only select repositories or All repositories. You can also start from the GitHub App page.
3. 3

   Let OpenMerge activate

   GitHub sends you back to OpenMerge, which registers the repositories you selected. When it finishes, your dashboard opens.

Get your first review#

Open a pull request in one of the selected repositories, or push a new commit to one that is already open. There is nothing to configure and nothing to add to your CI. OpenMerge reacts to the opened, reopened, and synchronize (new commits) events from GitHub.

What you will see#

• A short Review in progress note appears on the pull request as soon as the review is queued.
• Findings are posted as inline comments on the changed lines, each with a severity and, where it helps, suggested code.
• The progress note is replaced by a summary with a verdict: changes requested, non-blocking suggestions, or looks good to merge.
• The review also appears on the Reviews page of your dashboard.

Nothing showing up? See Troubleshooting.