Pull Requests Overview

This page explains how pull requests (PRs) work, how to create and manage them, and the best practices for collaboration and review.

Pull Requests allow you to merge updates from a source branch into a target branch. They support code review, conflict detection, and ensure changes are approved before being integrated.

PRs are central to collaboration, helping teams:

  • Review changes before merging

  • Detect and resolve conflicts early

  • Maintain a clean release history

⚠️ Important: Always validate and resolve conflicts before merging to avoid overwriting critical changes.

How To Create a Pull Request

You can open the Create Pull Request screen in two ways:

  1. From the Pull Requests tab → click Create pull request.

  2. From a Branch Code tab → click the ⋮ menu → select Create pull request.

Steps

  1. Select a Target branch (where changes will be merged).

  2. Select a Source branch (where changes exist).

  3. Enter a name for the pull request.

  4. Add a description summarizing the changes.

  5. Assign reviewers (optional but recommended).

  6. Click Create.

Pull Request Overview Page

The Pull Request overview page provides a detailed snapshot of each request. From here, you can:

  • View the title and PR ID.

  • See the merge path (source → target branch).

  • Check the status (Created, Review Requested, Changes Requested, Approved, Closed).

  • Identify the author and assigned reviewers.

  • Track the latest activity including timestamps.

  • Access actions from the ⋮ menu:

    • Edit – update the PR’s name, description, or target branch.

    • Close – terminate the PR without merging.

This view is the central hub for tracking progress and deciding whether a PR is ready to merge.

Pull Request List View

When viewing the Pull Requests page, you can use filters and see key columns.

  • Search – search by PR name or ID.

  • Authors – filter by PR creator.

  • Status – filter by state (Created, Review Requested, Changes Requested, Approved).

  • Reviewers – filter by assigned reviewers.

  • Latest Activity – sort pull requests by:

    • Sort by name A–Z – alphabetical order.

    • Sort by name Z–A – reverse alphabetical order.

    • Latest activity – most recent updates first.

    • Oldest activity – earliest updates first.

  • Date Range – filter by creation or update timeframe.

Pull Request Columns

  • ID & Title – PR number and name.

  • Branch Path – merge direction (e.g., Feature → ReleaseBranch).

  • Status – current PR state.

  • Author – who created the PR.

  • Reviewers – assigned reviewers.

  • Latest Activity – last update details.

  • Actions (⋮) – edit, review, or close a pull request.

Pull Request Statuses

  • Created – PR opened but not yet reviewed.

  • Review Requested – waiting for reviewers to check and provide feedback.

  • Changes Requested – reviewers requested modifications before approval.

  • Approved – PR has been approved and is ready to merge.

  • Closed – PR was closed without merging.

Editing a Pull Request

  • On the Pull Requests page, click the ⋮ menu beside the PR.

  • Select Edit.

  • Update the target branch, name, or description.

  • Click Save.

Closing a Pull Request

  • On the Pull Requests page, click the ⋮ menu beside the PR.

  • Select Close.

  • A confirmation dialog appears: “Are you sure you want to close this pull request?”

  • Click Yes to confirm.

Example

Merging Feature-02 into ReleaseBranch-01 ensures new functionality is reviewed and tested before release. Reviewers can request changes, resolve conflicts, and approve before the merge is finalized.

Best Practices

  • Always raise a PR before merging feature or bug-fix branches.

  • Write clear titles and descriptions for reviewers.

  • Assign at least one reviewer for accountability.

  • Resolve conflicts in the PR before merging.

  • Close stale PRs to keep the list clean.

Last updated

Was this helpful?