Tech Writing Sample #1

Creating Your First GitHub Pull Request (No Terminal Required)

By Taylor Banks
A beginner-focused walkthrough for creating pull requests using GitHub’s web interface (no terminal required).

Overview

A pull request (PR) is how developers propose changes to a shared codebase. It lets you ask others to review and approve your edits before merging them into the main project. Pull requests are at the heart of collaborative software development.

Who Is This For?

This walkthrough is intended for anyone new to Github, or anyone contributing to a shared coding project for the first time.

Prerequisites

Before starting, you should ensure you have:

• A GitHub account
• A repository (your own or a fork)

What You’ll Learn

• How to create a pull request using the GitHub web interface
• How to request review

What Is a Pull Request?

A pull request is a request for your changes to be reviewed and potentially merged into another branch. It’s a structured way to collaborate, discuss, and track proposed changes.

PRs are typically opened:

• From a branch (where you made your changes)
• Into another branch (like main or master)
• With a description explaining what you changed and why

PRs let teams:

• Review code before it’s merged
• Catch bugs and suggest improvements
• Maintain a clean, reliable codebase

When and Why to Create a Pull Request

You may want to use a PR if you want to:

• Work in a team
• Contribute to open source code

Step-by-Step: Creating a Pull Request

Step 1: Fork the Repository

If you’re contributing to a project you don’t own (like an open-source repo), start by forking it. This creates your own copy of the project under your GitHub account, so you can make changes without affecting the original.

• Click Fork in the top right of the repo page.

Step 2: Create a New Branch

Before making changes, it’s best to create a new branch. This keeps your edits separate from the main project until they’ve been reviewed and approved.

To create a new branch on GitHub:

1. Go to your forked repository page.
2. Find the branch selector dropdown near the top-left.
3. Click it, and type a name for your new branch
4. Click “Create branch: BranchName from ‘master’”.

You’re now working in your new branch. Any changes you make will be part of this branch and not the main project.

Step 3: Make Your Changes

1. To add a new file:
   • Click Add File in the top-right
   • Click Create New File or Upload Files in the dropdown
2. To modify an existing file:
   • Click Edit File in the bottom-right

3. Commit your changes:
   • Click Commit Changes in green
   
4. Type a description of the change you made, then click Commit Changes.

Step 4: Open the Pull Request

If GitHub shows a green “Compare & pull request” button, click it. Otherwise:

1. Go to the original repository
2. Click the Pull Requests tab
3. Click New Pull Request.
4. Click Compare Across Forks.
   • Note: Make sure the comparison is set to:
     • base: the main branch of the original repo
     • compare: your fork and your branch
5. Add a title and a short description of what you changed.
6. Click Create Pull Request.

Step 5: Request Review (Optional)

A review is when someone looks at your pull request and either approves it, requests changes, or leaves comments and suggestions. To request a review from a specific person:

1. Find the “Reviewers” section on the right-hand side of the pull request page.
2. Click the gear icon (⚙️).
3. Select a collaborator from the list.
   • Note: You can only request reviews from users who have permission to contribute to the original repository.

4. Common Mistakes (and How to Avoid Them)

1. Making Changes Directly to the Main Branch

 Problem: This defeats the purpose of the PR. 
 Solution: Always create a new branch for your changes.

2. Unclear Pull Request Descriptions

Problem: Reviewers don't know what you changed or why.
Solution: Summarize what the PR does and why it matters.

3. Wrong Base/Compare Branches

Problem: You might accidentally merge into the wrong branch.
Solution: Always double check that "base" is the branch you want to merge into and "compare" is your feature branch.

4. Forgetting to Sync Your Fork

Problem: Your fork may be outdated, leading to merge conflicts.
Solution: Before starting new work, always sync your fork with the original repo.

5. Large, Unfocused PRs

Problem: These are difficult to review, and it's easy to miss bugs.
Solution: Always make your PRs small and focused. Limit yourself to one or two changes at a time.

5. Summary

Pull requests are more than just a GitHub feature. They’re a best practice for working on shared code. They give teams a safe way to review, improve, and manage changes before merging them into the main project.

Once you understand pull requests, you’re ready to contribute to real-world software — whether it’s your own or someone else’s.

Try It Yourself

Now that you understand how pull requests work, try it on your own:

1. Create a new repository on GitHub.
2. Add a README or any test file.
3. Create a branch, make a small edit, and open a pull request just like you practiced here.
4. Want more practice? Fork a public repo with a good first issue, make a real contribution, and open a pull request for review.

6. Further Reading & Resources

• GitHub Docs: Creating a pull request
• GitHub Hello World tutorial
• Video: GitHub Pull Requests in 4 Minutes

This guide was created as part of a technical writing portfolio project. All examples use public GitHub repositories, and screenshots were taken from the GitHub web interface as of June 2025.