Quickstart

Roughly five minutes, most of it GitHub's install screen.

1. Sign in

Go to app.ez-merge.com and choose Continue with GitHub. EasyMerge asks GitHub for your identity only; repository access comes in the next step.

2. Install the GitHub App

From the dashboard, start the install flow and pick where EasyMerge should live:

• Your personal account — for your own repositories.
• An organization — you need to be an owner, or an owner has to approve the request.

Then choose All repositories or Only select repositories. You can change this later on GitHub without reinstalling.

3. Check that your repository is there

GitHub sends you back to EasyMerge once the install is confirmed, and your repositories are read in straight away — you do not have to sync by hand. Open Repositories and every repository the installation covers is listed. If one is missing, press Sync From GitHub on the dashboard home to re-read your installations.

Reviews are on by default for newly connected repositories.

4. Open a pull request

Push a branch and open a PR against the default branch. Within a few seconds:

• an EasyMerge Review check appears on the PR, first as queued, then in progress;
• the review shows up in the dashboard under Reviews, updating live as it progresses.

5. Read the review

When the review finishes, EasyMerge posts a single GitHub review. Its body leads with a recommendation — ⛔ Blocked through to ✓ No issues found — a written summary of the change, and a merge confidence reading out of 10; each finding it posts sits as an inline comment on the line it refers to.

Out of the box a review posts its warning and critical findings, up to twenty of them. Anything else it found is kept and readable in the dashboard. Both are adjustable — see Repository settings.

Findings carry a severity of critical, warning, or info, visible on the review in the dashboard. Where the model can propose a concrete fix, the comment includes a suggestion block that GitHub turns into a Commit suggestion button.

6. Tune it

Open the settings page of any repository to turn reviews off, to change how many files a review reads, or to exclude paths — generated code, fixtures, vendored files — from every future review.

Next

• Install the GitHub App — permissions, organizations, and changing repository access later.
• Connect repositories — syncing, filtering, and who is allowed to change settings.
• Your first review — what to expect on the pull request, in detail.