Create Pull Request
Create a pull request with a concise, well-formatted description.
Workflow
- •Verify branch: Ensure you're NOT on main/master branch
- •Review changes: Check git status and recent commits
- •Check with user: Confirm before pushing (per user's git workflow rules)
- •Push to origin: Push to
originfrom the current branch (if needed) - •Create PR: Use
gh pr createwith concise description - •Format description: Small bullet points, derived from conversation and commits
PR Description Format
Keep it very concise. Use this structure:
code
### Why are you making these changes? <1-3 sentences explaining the motivation/problem being solved> ### How was this tested? <Brief description of testing approach>
Good examples
code
### Why are you making these changes? Fix deduplication bug in welcome message that caused duplicate entries when users rejoined. ### How was this tested? Manual testing with multiple rejoin scenarios. Added unit test for dedup logic.
code
### Why are you making these changes? Add cache timestamp on initial install to prevent stale cache issues reported in #123. ### How was this tested? Verified cache invalidation works correctly after fresh install and upgrade paths.
Bad examples (too verbose)
code
### Why are you making these changes? This PR implements a comprehensive solution to fix the deduplication logic in the welcome message handler by refactoring the underlying data structure and adding a new sorting algorithm that improves performance by 50% while also addressing technical debt...
Instructions
- •
Check current branch:
git branch --show-current- •If on main/master, stop and ask user to create a feature branch
- •
Review changes:
- •Run
git statusto see what's committed - •Run
git log main..HEAD --oneline(ormaster..HEAD) to see commits - •Review recent conversation for context
- •Run
- •
Check remote status:
- •Run
git statusto see if branch is already tracking remote - •If already pushed and up-to-date, skip push step
- •Run
- •
ASK USER: "Ready to push and create PR? Here's what will be pushed: [list commits]"
- •Wait for user confirmation
- •This respects the user's git workflow rules
- •
Push changes (if user confirmed and needed):
bashgit push -u origin <current-branch>
- •
Create PR with concise description:
bashgh pr create --title "Brief title" --body "$(cat <<'EOF' ### Why are you making these changes? Brief explanation of what this change does and why. ### How was this tested? Description of testing approach. EOF )"
- •
Open the PR using
open.
Key principles
- •Be concise: Each bullet should be one line
- •Focus on what: Describe the change, not implementation details
- •Derive from context: Use commit messages and conversation
- •No fluff: Avoid phrases like "This PR implements" or "In this change"
- •Action-oriented: Start bullets with verbs (Add, Fix, Update, Remove)
Notes
- •If
gh pr createfails because PR already exists, usegh pr view --webto open it - •Always respect user's git workflow rules (check before push, use feature branches)
- •If branch is already pushed and up-to-date, can skip directly to PR creation