Pull Requests

follow
4 Contributors contributor avatar contributor avatar contributor avatar contributor avatar
5 minutes read
Last updated 03 May 13:50

Also known as Merge Requests.

TL;DR

Pull requests tell other team members that you changed something in the code and pushed the change to a branch in a git repository.

What Is a Pull Request

A pull request is a practice of getting feedback from other programmers and deciding to "merge" or "do not merge" the code before it is merged into the main codebase.

If "do not merge decision" is made, author of the code can address the comments of others and re-submit the code for another round of review. This continues until all issues with code are resolved and the code can be merged. Or until the idea behind the code is no longer in alignment with the project goals and the pull request is rejected.
For more information, see the Code Review practice.

Pull request can also trigger CI/CD to make sure all automated tests pass before the code can be merged. For more infomration, see Continuous Integration and Continuous Delivery.

Pull Request
Source: Tuleap: Pull Request

Why You Might Want the Pull Request?

  • Using pull request helps you catch the bad code before it is merged into the main codebase.
  • Author of the code can also gain valuable feedback on his work that can be immediately applied when fixing the pull request.
  • The knowledge of the codebase is spread more evenly in the team when pull requests practice is in place.
  • The Team Leader or the senior colleague can use pull requests to continually evaluate performances of other team members.

Problems the Pull Request Helps to Solve

How to Implement the Pull Requests

  1. Explain the pull requests practice to the team, have a discussion about benefits vs. drawbacks the team can be afraid of.
  2. Adjust the workload for the team so they have enough time for doing the pull requests.
  3. Make rules on who will be reviewing what. The rules will be depending on your goals.
    • If knowledge sharing is a priority, assign the pull request to someone who does not know this part of the codebase.
    • If a code quality is a priority, let the more senior team members do the review of the more junior members' code. Senior members can do the Code Review with each other.
    • If culture is especially toxic, a simple round-robin style of pull request assignment can be seen as “fair”.
    • Rules can be usually enforced by Version Control System (CVS).
  4. Demonstrate to the team the pull request flow in your CVS.
  5. Start practicing pull requests within the team.
  6. Continuously give feedback to the team, fine-tune the rules so it fits the team.
  7. Encourage short pull requests, preferably with not more than 250 lines changed. Large code changes make finding bugs much more demanding and hinder the code review process. A way to minimize large pull requests is to break down broad features into smaller independent tasks that your dev team can solve individually. Small pull requests allow multiple developers to work on issues simultaneously and thus speed up product development.
  8. Practice having relevant titles and descriptions for your pull requests. The pull request description should always explain why the person created the pull request, what issues it solves, and how. The best pull request should also mention relevant people. Additionally, adding a screenshot or GIF to demonstrate the visual changes can go a long way in simplifying code review.

Example Pull Request
Source: The anatomy of a perfect pull request

  1. Add a pull request template to the root directory of your repositories. Alternatively, you can also add it to docs/ ,PULLREQUESTTEMPLATE/ or .github/. Pull request templates are markdown or simple text files that get added to the pull request description automatically. Name the file pullrequesttemplate.md and include the formatting that you want to use in your pull requests. Using templates makes code review smoother by standardizing pull requests and also helps inexperienced developers write good pull requests.

Common Pitfalls of Pull Requests

  • Make sure that the pull requests are done regularly in your team and that nobody waits way too long for their code to be reviewed. If the code is left unchecked, it can lead to “long feedback loops” and it can effect team motivation.
  • Always have at least two possible approvers for each pull request. Having only one person that can merge pull requests could lead to power hoarding.

Resources for Pull Requests