Skip to main content

Working with Pull Requests

Pull Requests are a key feature of any Git-based workflow. They are the primary way of introducing changes into a project, and provide a way to propose changes, have a discussion about them, and get them reviewed and finally merged into the main project. In this tutorial, we will learn how to work with Pull Requests on GitHub.

What is a Pull Request?​

To put it simply, a Pull Request (PR) is a proposal to change something in a repository. It's a way of asking the project maintainers to consider your changes and, if they agree, to merge them into the main project.

Here's how it works:

  1. You fork the main repository (create your own copy of it).
  2. You make some changes in your fork (usually on a separate branch).
  3. You create a Pull Request in the main repository, proposing to merge your changes.

Creating a Pull Request​

Here's how you can create a Pull Request on GitHub:

  1. Navigate to the main page of the repository.
  2. Click the "Pull requests" tab.
  3. Click the "New pull request" button.
  4. In the "compare" dropdown, select the branch with your changes.
  5. Review your changes and click "Create pull request".

You'll need to write a message explaining what changes you've made and why. Then, you can assign reviewers who will look at your changes and approve them (or request additional changes).

Reviewing a Pull Request​

When someone has created a Pull Request, it's time for a review. Here's how you can review a Pull Request on GitHub:

  1. Navigate to the "Pull requests" tab in the repository.
  2. Click on the Pull Request you want to review.
  3. You'll see the changes proposed by the Pull Request. Added lines are shown in green, and removed lines are shown in red.
  4. If you want to suggest changes, you can leave comments on the lines of code.
  5. If everything looks good, you can approve the Pull Request. If not, you can request changes.

Merging a Pull Request​

Once a Pull Request has been reviewed and approved, it's time to merge it. Here's how you can merge a Pull Request on GitHub:

  1. Navigate to the "Pull requests" tab in the repository.
  2. Click on the Pull Request you want to merge.
  3. Click "Merge pull request".
  4. Click "Confirm merge".

The changes proposed by the Pull Request are now part of the main project!

Conclusion​

Pull Requests are a powerful tool for collaborating on projects. They allow you to propose changes, discuss them, review them, and finally merge them into the main project. By using Pull Requests effectively, you can ensure that your projects are always improving and that everyone's contributions are valued and included.