How to resolve Git merge conflicts

Don't panic when you encounter a merge conflict. With a little expert negotiation, you can resolve any conflict.
5 readers like this.
Coding on a computer

Suppose you and I are working on the same file called index.html. I make some changes to the file, commit them, and push the changes to the remote Git repository. You also make some changes to the same file, commit them, and start pushing the changes to the same Git repository. However, Git detects a conflict because the changes you made conflict with the changes I made.

Here's how you can resolve the conflict:

  1. Fetch and merge the latest changes from the remote repository:

    $ git pull
  2. Identify the one or more conflicting files:

    $ git status
  3. Open the conflicting file using a text editor:

    $ vim index.html
  4. Resolve the conflict. The conflicting changes are marked by <<<<<<< HEAD and >>>>>>>. You need to choose which changes to keep and which to discard. Manually edit the file to combine the conflicting changes. 

    Here's an example:

    <<<<<<< HEAD
    <div class="header">
    <h1>Sample text 1</h1>
    </div>
    =======
    <div class="header">
    <h1>Sample text 2</h1>
    </div>
    >>>>>>> feature-branch

    In this example, I changed the website heading to Sample text 1, while you have changed the heading to Sample text 2. Both changes have been added to the file. You can now decide which heading to keep or edit the file to combine the changes. In either case, remove the markers that indicate the beginning and end of the changes, leaving only the code you want:

    <div class="header">
    <h1>Sample text 2</h1>
    </div>
  5. Save all of your changes, and close your editor.

  6. Add the file to the staging area:

    $ git add index.html
  7. Commit the changes:

    $ git commit -m "Updated h1 in index.html"

    This command commits the changes with the message Resolved merge conflict.

  8. Push the changes to the remote repository:

    $ git push

Resolution

 Merge conflicts are a good reason to focus your changes on code. The more you change in a file, the greater the potential for conflict. You should make more commits with fewer changes each. You should avoid making a monolithic change that combines multiple feature enhancements or bug fixes into one. Your project manager will thank you, too, because commits with clear intent are easier to track. A Git merge conflict may seem intimidating at first, but now that you know how to do it, you'll see that it's easily resolved.

Tags
Avatar
Agil has more than 6 years of experience as a technical writer that specialises in producing accurate, clear, and concise documentation for software products. He has the ability to communicate technical ideas to a variety of audiences, including developers, engineers, and end users.

2 Comments

I always recommend that people add the following to their ~/.gitconfig file:

[merge]
conflictstyle = diff3

With this in place, when there are conflicts, you won't just see the two sources (your text and the conflicting text from the file being merged in), but you'll also see a block of text representing the common-ancestor text for the region in conflict.

This often provides very useful information to help resolve the conflict.

Creative Commons LicenseThis work is licensed under a Creative Commons Attribution-Share Alike 4.0 International License.