Github - Pull Request (PRs)

GitHub - Pull Request (PRs)

Introduction to GitHub Pull Requests

Pull Requests (PRs) are one of the core features of GitHub, enabling developers to propose, discuss, and collaborate on code changes before integrating them into the main project. Whether you're working in a large organization, contributing to open-source, or managing personal projects, understanding GitHub Pull Requests is essential to maintain a clean, collaborative, and quality-driven development workflow.

This comprehensive guide explores how GitHub Pull Requests work, how to create and review them, the importance of branching strategies, the integration with CI/CD pipelines, and best practices for managing collaborative development with PRs.

What is a Pull Request?

A Pull Request (PR) is a request to merge code changes from one branch into another. Typically, developers make changes on a feature branch and then create a pull request to merge those changes into the main  or develop branch. Pull requests allow for code review, discussion, testing, and validation before any code is merged into the central repository.

Why Use Pull Requests?

• Facilitates code review before merging
• Allows inline comments and suggestions
• Triggers automated tests and CI/CD workflows
• Improves collaboration across teams
• Provides an audit trail for all code changes

Branching Strategy for Pull Requests

Common Workflow

# Create a feature branch
git checkout -b feature/new-component

# Make changes and commit
git add .
git commit -m "Added new component"

# Push the branch to GitHub
git push origin feature/new-component

Once your branch is pushed, you can create a pull request through GitHub’s web interface or CLI.

Creating a Pull Request on GitHub

1. Push a Feature Branch

git push origin feature/login-page

2. Open GitHub in Your Browser

GitHub usually shows a prompt to compare & create a pull request once it detects a new branch pushed. Click on “Compare & Pull Request”.

3. Fill Out PR Details

• Title: A short, descriptive summary of the change
• Description: Explain what the change does and why it's necessary
• Reviewers: Tag teammates or code reviewers
• Labels: Classify the PR (bug, feature, enhancement)
• Linked Issues: Automatically closes issues using Fixes #123 

4. Create the Pull Request

Click the Create Pull Request button to open your PR and begin the review process.

Understanding the Pull Request Interface

1. Conversation Tab

The default view shows a thread of all comments, reviews, and updates related to the pull request.

2. Commits Tab

Lists all commits that are included in the PR.

3. Files Changed Tab

Displays a diff view of all files that were modified, allowing inline comments and suggestions.

4. Review Tools

Code reviewers can:

• Comment on specific lines of code
• Request changes
• Approve the pull request

Reviewing a Pull Request

Step-by-Step Review Process

1. Go to the Files changed tab
2. Inspect code line-by-line
3. Use the + icon to leave inline comments
4. Request changes or approve the PR

Submit Review

# Options
- Comment: general feedback
- Approve: accept PR as-is
- Request changes: requires modifications

Merging a Pull Request

Once approved and checks pass, the PR can be merged into the base branch.

Merge Options

• Create a Merge Commit: Keeps all commit history
• Squash and Merge: Combines all commits into one
• Rebase and Merge: Applies commits on top of base branch without merge commit

# Merge via CLI
git checkout main
git pull origin main
git merge feature/new-component
git push origin main

Pull Requests and Continuous Integration

PRs can trigger CI pipelines, which automatically run tests, linters, or build tools to ensure code quality before merging.

Common Integrations

• GitHub Actions
• CircleCI
• Travis CI
• Jenkins

# .github/workflows/test.yml
name: Run Tests

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Dependencies
        run: npm install
      - name: Run Tests
        run: npm test

Draft Pull Requests

You can mark a PR as a draft if it’s not yet ready for review.

This signals that development is in progress. Reviewers cannot merge a draft PR until it’s marked ready.

Best Practices for Effective Pull Requests

1. Keep PRs Small and Focused

• Break down features into small, manageable PRs

2. Write Clear Commit Messages

git commit -m "Add login component with validation logic"

3. Use Descriptive Titles and Summaries

Provide context for reviewers to understand the purpose and scope of the changes.

4. Link Related Issues

Fixes #23
Closes #45

5. Run Tests Before Opening PRs

npm run test

6. Tag Reviewers and Assignees

Ensure that the right people are notified for review and feedback.

7. Don’t Forget to Pull Before Creating a PR

git pull origin main --rebase

Syncing and Updating an Open Pull Request

If changes are made in the base branch or new commits are required, update your PR:

# Make additional changes
git add .
git commit -m "Update based on review"

# Push new commits
git push origin feature/branch-name

Closing a Pull Request

If the changes are no longer relevant, the PR can be closed without merging.

• Click Close Pull Request from the web interface
• Or use gh pr close  if using GitHub CLI

Deleting Feature Branch After Merge

Once the PR is merged, you can delete the branch:

git push origin --delete feature/branch-name

Or click Delete branch from the GitHub interface after merging.

Using GitHub CLI for Pull Requests

Create a Pull Request

gh pr create --base main --head feature/login-page --title "Login Page" --body "Adds login functionality"

View Pull Requests

gh pr list

Checkout a Pull Request Locally

gh pr checkout 123

Handling Conflicts in Pull Requests

If the base branch has changes that conflict with your PR, GitHub will show a merge conflict warning.

Resolve Conflicts Locally

git fetch origin
git checkout feature/branch-name
git merge origin/main

# Resolve conflicts manually
git add .
git commit
git push origin feature/branch-name

PR Templates for Standardization

You can add a pull request template to your repository to enforce structure and consistency.

# .github/pull_request_template.md

## Description
Please include a summary of the changes and the related issue.

## Checklist
- [ ] Code compiles correctly
- [ ] Tests added or updated
- [ ] Documentation updated

Pull Requests are the heart of collaborative software development on GitHub. They provide a structured way to propose, review, and integrate code changes while promoting code quality, team communication, and workflow automation. Whether you're a solo developer or part of a large engineering team, mastering Pull Requests is essential to delivering high-quality software.

By following best practices, leveraging CI integrations, and using tools like GitHub CLI and templates, you can create efficient, maintainable, and secure development pipelines. With this detailed knowledge, you’re ready to take full advantage of GitHub Pull Requests in your development workflow.