Documentation

Everything you need to get started with MergeBetter and prevent merge conflicts in your team.

Quick Start

Get MergeBetter running in 3 steps:

1

Install GitHub App

Install MergeBetter on your repositories

2

Start Your Trial

14-day free trial, no credit card required

3

Create Pull Requests

MergeBetter automatically analyzes conflicts

Ready to start?

Install the GitHub App and start preventing merge conflicts today.

Install MergeBetter →

Installation Guide

Step 1: Install the GitHub App

  1. Visit the MergeBetter GitHub App page
  2. Click "Install" and choose your organization or personal account
  3. Select repositories where you want conflict detection:
    • All repositories: Monitor all current and future repos
    • Selected repositories: Choose specific repos to monitor
  4. Review and accept the permissions
  5. Complete the installation

Step 2: Configure Settings (Optional)

After installation, you can customize MergeBetter's behavior:

  1. Visit your MergeBetter Dashboard
  2. Sign in with your GitHub account
  3. Select your installation
  4. Adjust settings:
    • PR Staleness Mode: Control which PRs are analyzed
    • Notifications: Enable/disable conflict comments

Step 3: Start Using

Once installed, MergeBetter automatically starts monitoring:

  • New pull requests are analyzed when opened
  • Existing PRs are re-analyzed when updated
  • Conflict warnings appear as PR comments
  • No additional setup required!

How It Works

Conflict Detection Process

1. Event Trigger

GitHub webhook fired when PR is opened, updated, or new commits are pushed

2. Collect Open PRs

Fetch all open pull requests in the repository for comparison

3. Analyze Diffs

Compare file changes between PRs to detect overlapping modifications

4. Post Warnings

Comment on PRs with detailed conflict warnings and affected files

Example Conflict Warning

🔶 Potential Merge Conflict Detected

Severity: 🟠 Medium Effort

This PR may have merge conflicts with 1 other open PR:

PR #42: Add user authentication

📄 src/auth.js

• Lines 15-23: Function signature changes

📄 src/user.js

• Lines 8-12: Import statement modifications

💡 Consider coordinating with @alice to avoid conflicts before merging.

Customer Dashboard

Access Your Dashboard

Manage your installations, view usage, and handle billing through your customer dashboard.

Open Dashboard →

Dashboard Features

📊 Installation Overview

View all your GitHub App installations, subscription status, and repository count.

📈 Usage Analytics

Monitor webhook processing, conflicts detected, and active team members.

💳 Billing Management

Upgrade plans, manage subscriptions, and access Stripe Customer Portal.

⚙️ Settings Control

Configure conflict detection preferences and notification settings.

Configuration Options

PR Staleness Filtering

All PRs (Default)

Analyze all open pull requests regardless of age

Recent PRs Only

Only analyze PRs updated in the last 7 days

Non-Stale PRs

Exclude PRs that haven't been updated in 30+ days

Billing & Plans

How Billing Works

Member-Based Pricing

You're charged based on the number of active users whose pull requests are analyzed by MergeBetter.

Automatic Counting

We automatically sync your organization members monthly to ensure accurate billing.

Repository Selection

Install on specific repositories to control which team members are included in billing.

Plan Management

Upgrade, downgrade, or cancel anytime through your dashboard or Stripe portal.

Available Plans

Trial: 14 days free, any team size
Starter: $19/month for up to 10 active users
Team: $99/month for up to 50 active users
Enterprise: Custom pricing for unlimited users

Troubleshooting

MergeBetter isn't analyzing my PRs

Check:

  • The GitHub App is installed on the correct repository
  • The repository has webhook delivery enabled
  • There are multiple open PRs to compare
  • Your trial hasn't expired or subscription is active

I'm not receiving conflict notifications

Possible causes:

  • Notifications are disabled in your installation settings
  • PRs don't have overlapping file changes
  • PRs are filtered out by staleness settings
  • Conflicts were already detected and commented on

Billing or subscription issues

For billing questions:

  • Check your dashboard for subscription status
  • Use the Stripe Customer Portal to manage billing
  • Contact [email protected] for assistance

Need Help?

Our support team is here to help you get the most out of MergeBetter.