How to use merge rules

Add more control to the way your team collaborates on change requests by setting merge rules

Merge rules give you more control over how change requests are reviewed and merged, helping teams maintain quality and consistency.

This video and guide will take you through merge rules in GitBook, covering:

• Where to set up merge rules to control who has access to push changes live

• Configuring specific rules, like requiring reviews

• and more!

What are merge rules?

Merge rules restrict when a change request can be merged. They make sure specific conditions are met before changes go live.

You can apply merge rules at the organization level or per space.

Where to manage merge rules

There are a few places you can manage merge rules for your organization. All spaces within an organization will inherit the organization’s rules, unless updated and specified in a space.

Organization-wide

Head to your organization’s settings, and then to merge rules. From here you can set rules that will apply to all spaces in the organization.

Per-space

When working in a space, to update it’s merge rules, click the 3 dots next to to the space name, and select “merge rules”.

If you’re working in a space inside of a change request, head to the overview tab of your change request, and click the settings icon in the merge rules section to configure your rules.

Configure merge requirements

When you create or edit a merge rule, you can require things like:

• At least one review before merging

• Reviews from specific team members

• The change request to be up to date

• Required metadata (like a subject and description)

Read our full merge rules docs to find out more about merge requirements.

Enforce quality and consistency

Merge rules help keep change requests reviewed, complete, and current. And that helps you keep documentation quality high and reduces mistakes going live.