create-github-pr

Create GitHub Pull Request

Create pull requests on GitHub using the gh CLI.

Prerequisites

• The gh CLI must be authenticated (gh auth status)
• You must have commits on a branch that's pushed to the remote
• Branch should follow naming convention: <issue-number>-<description>/<username>

Before Creating a PR

Run Pre-commit Checks

Run the local pre-commit task before opening a PR:

mise run pre-commit

Verify Branch State

Before creating a PR, verify:

1. You're not on main - Never create PRs directly from main:

   # Should NOT be "main"
   git branch --show-current
   

2. Branch follows naming convention - Format: <issue-number>-<description>/<initials>

   # Example: 1234-add-pagination/jd
   git branch --show-current
   

3. Consider squashing commits - For cleaner history, squash related commits before pushing:

   # Squash last N commits into one
   git reset --soft HEAD~N
   git commit -m "feat(component): description"
   

Push Your Branch

Ensure your branch is pushed to the remote:

git push -u origin HEAD

Creating a PR