Create Pull Request
Create a pull request with a concise, well-formatted description.
Workflow
- •Verify branch: If on master, automatically create a feature branch
- •Push to origin: Always push to
originfrom the current branch - •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
## Summary <1-3 bullet points of what changed> ## Test plan [Optional: Only if testing steps are needed]
Good examples
code
## Summary - Fix deduplication in welcome message - Add sorting to package list - Improve logging on package updates
code
## Summary - Add cache timestamp on initial install - Prevent stale cache issues
Bad examples (too verbose)
code
## Summary - 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...
Instructions
- •
Check current branch:
git branch --show-current- •If on master, automatically create a feature branch:
Use a short descriptive name based on the changes (e.g.,bash
git checkout -b feature/<descriptive-name>
feature/fix-cache,feature/add-logging)
- •If on master, automatically create a feature branch:
- •
Review changes:
- •Run
git statusto see what's committed - •Run
git log master..HEAD --onelineto see commits - •Review recent conversation for context
- •Run
- •
Push changes:
bashgit push -u origin <current-branch>
- •
Create PR with concise description:
bashgh pr create --title "Brief title" --body "$(cat <<'EOF' ## Summary - First change - Second change - Third change EOF )"
- •
Return the PR URL to the user
- •
Open the PR in the browser:
bashopen <PR_URL>
Replace
<PR_URL>with the actual PR URL returned fromgh pr create
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)