How to Create a Pull Request Using GitHub CLI This guide explains how to create pull requests using GitHub CLI in our project. Important : All PR titles and descriptions should be written in English. Prerequisites Check if gh is installed, if not follow this instruction to install it: 1. Install GitHub CLI if you haven't already: 2. Authenticate with GitHub: Pre flight Checks Before creating a PR, check for uncommitted changes: 1. Run git status to check for uncommitted changes (staged, unstaged, or untracked files) 2. If uncommitted changes exist, use the Skill tool to run the commit skill first: 3. This ensures all your work is committed before creating the PR Creating a New Pull Request 1. First, prepare your PR description following the template in @.github/pull request template.md 2. Use the gh pr create draft command to create a new pull request: For more complex PR descriptions with proper formatting, use the body file option with the exact PR template structure: Best Practices 1. Language : Always use English for PR titles and descriptions 2. PR Title Format : Use conventional commit format with emojis Always include an appropriate emoji at the beginning of the title Use the actual emoji character (not the code representation like :sparkles: ) Examples: ✨(supabase): Add staging remote configuration 🐛(auth): Fix login redirect issue 📝(readme): Update installation instructions 3. Description Template : Always use our PR template structure from @.github/pull request template.md: 4. Template Accuracy : Ensure your PR description precisely follows the template structure: Don't modify or rename the PR Agent sections ( pr agent:summary and pr agent:walkthrough ) Keep all section headers exactly as they appear in the template Don't add custom sections that aren't in the template 5. Draft PRs : Start as draft when the work is in progress Use draft flag in the command Convert to ready for review when complete using gh pr ready Common Mistakes to Avoid 1. Using Non English Text : All PR content must be in English 2. Incorrect Section Headers : Always use the exact section headers from the template 3. Adding Custom Sections : Stick to the sections defined in the template 4. Using Outdated Templates : Always refer to the current @.github/pull request template.md file Missing Sections Always include all template sections, even if some are marked as "N/A" or "None" Additional GitHub CLI PR Commands Here are some additional useful GitHub CLI commands for managing PRs: Using Templates for PR Creation To simplify PR creation with consistent descriptions, you can create a template file: 1. Create a file named pr template.md with your PR template 2. Use it when creating PRs: Related Documentation [PR Template](.github/pull request template.md) [Conventional Commits](https://www.conventionalcommits.org/) [GitHub CLI documentation](https://cli.github.com/manual/)

create-pr