Pull request

A pull request is a proposal to merge a set of code changes from one branch into another, opened on a platform such as GitHub so others can review and discuss it first.

Why it matters for agencies

The pull request is where code review, automated checks and the link to a task all meet. How well it is written decides how fast it gets reviewed and how easily the change can be understood later.

How to do it or work it out

Give it a title that says what changed and, if you use a task tracker, include the task ID. Describe the reason for the change, how it was tested and anything the reviewer should look at first.

Keep it focused on one change. If it needs several unrelated parts, split it into several pull requests.

Link the pull request to its task, mark drafts as drafts and answer review comments in the thread. Merge only when checks pass, and delete the branch afterwards so the repository stays readable.

A worked example

A developer opens a pull request titled with the ClickUp task ID and a short summary, adds a description of the fix and how it was tested, and requests a review. Checks run, an automatic review leaves comments and a teammate approves after the fixes. Before anyone reads it, the title is checked against the team's pattern, such as a conventional commit prefix plus the task ID, using the pull request title validator. A missing ID is caught by a tool instead of a person.

Common mistakes

  • Titles such as fixes or wip. Titles appear in release notes and history, so say what changed.
  • Mixing a refactor with a feature. Reviewers cannot tell which lines matter, and a revert undoes both.
  • Opening it with no description. The reviewer has to guess the intent, and so will the next developer.

All glossary terms. General information, not financial, legal or accounting advice.

Review every pull request in Jasper

Jasper reviews each GitHub pull request with inline comments and suggested fixes, in the same workspace as your team chat.