Skip to content

PR

Creating a Pull Request - Step by Step

Method 1: Right After Pushing (Easiest)

When you push a new branch, GitHub shows a yellow banner:

After you run:

git push -u origin feature/your-feature-name

  1. Go to your repository: https://github.com/LarryAnglin/HelpDesk
  2. Look for the yellow banner at the top that says: feature/your-feature-name had recent pushes less than a minute ago [Compare & pull request]
  3. Click the green β€œCompare & pull request” button

Method 2: From the Pull Requests Tab

  1. Go to your repository: https://github.com/LarryAnglin/HelpDesk
  2. Click the β€œPull requests” tab (near the top, next to β€œCode”)
  3. Click the green β€œNew pull request” button
  4. Select your branches: - Base: develop (where you want to merge TO) - Compare: feature/your-feature-name (your branch)
  5. Click β€œCreate pull request”

Method 3: From Your Branch Page

  1. Go to: https://github.com/LarryAnglin/HelpDesk
  2. Click the branch dropdown (shows β€œmain” by default)
  3. Select your branch feature/your-feature-name
  4. Click β€œContribute” β†’ β€œOpen pull request”

πŸ“ Filling Out the PR Form

Once you click to create a PR, you’ll see a form:

  1. PR Title

Add user export functionality

  • Be descriptive but concise
  • Use present tense
  • No period at the end
  1. PR Description

The template will auto-fill. Here’s how to complete it:

Description

Added CSV export feature to allow admins to download user data with date filtering

Type of Change

  • πŸ› Bug fix
  • ✨ New feature ← Check the appropriate box
  • πŸ’₯ Breaking change
  • πŸ“ Documentation update

Testing

  • Tested locally
  • Tested on preview URL ← Will test after PR creates
  • Tested on staging

Screenshots

← Drag & drop images here

  1. Right Sidebar Options
  • Reviewers: Leave empty (CODEOWNERS auto-assigns)
  • Assignees: Assign to yourself
  • Labels: Add if you want (feature, bug, etc.)
  • Projects: Skip
  • Milestone: Skip
  1. Target Branch (IMPORTANT!)

Make sure:

  • Base: develop (NOT main!)
  • Compare: feature/your-feature-name

🎯 Visual Guide

Here’s what the PR creation page looks like:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Comparing changes β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ base: develop ← compare: feature/add-user-export β”‚ β”‚ β”‚ β”‚ βœ“ Able to merge (no conflicts) β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Add user export functionality [PR Title] β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ ## Description β”‚ β”‚ Added CSV export feature to allow admins… β”‚ β”‚ β”‚ β”‚ ## Type of Change β”‚ β”‚ - [x] ✨ New feature β”‚ β”‚ β”‚ β”‚ [Your PR description here…] β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

[Create pull request] ← Click this green button

πŸš€ After Creating the PR

  1. Wait 2-3 minutes for the preview URL
  2. Check the PR page for a comment like: πŸ”₯ Preview deployed to: https://your-project-idβ€”pr-42.web.app
  3. Test your feature on the preview URL
  4. Share the preview URL with others for feedback

πŸ’‘ Pro Tips

Adding Screenshots

  • Drag and drop images directly into the description
  • Or paste from clipboard (Cmd+V on Mac)
  • Use screenshots to show UI changes

Linking Issues

Fixes #42 ← Automatically closes issue 42 when PR merges Related to #43 ← Just links without closing

Draft PRs

  • Click dropdown arrow next to β€œCreate pull request”
  • Select β€œCreate draft pull request”
  • Good for work-in-progress

Quick PR from Command Line

Using GitHub CLI (if installed)

gh pr create β€”base develop β€”title β€œAdd user export”

🎬 Complete Example

1. Push your branch

git push -u origin feature/add-export

2. Terminal shows:

remote: Create a pull request for β€˜feature/add-export’ on GitHub by visiting: remote: https://github.com/LarryAnglin/HelpDesk/pull/new/feature/add-export

3. Click that link OR go to GitHub and click the yellow banner

4. Fill out:

Title: Add user export functionality for admin panel Base: develop Compare: feature/add-export Description: [Fill template]

5. Click β€œCreate pull request”

6. Wait for preview URL in comments

7. Test and share!

That’s it! The key is making sure you select develop as the base branch, not main. This ensures your code goes to staging first before production.