Use this skill when asked to create a pull request (PR). It ensures all PRs follow the repository's established templates and standards.
This skill guides the creation of high-quality Pull Requests that adhere to the repository's standards.
Follow these steps to create a Pull Request:
Branch Management: CRITICAL: Ensure you are NOT working on the
main branch.
git branch --show-current.main, you MUST create and switch to a new
descriptive branch:
git checkout -b <new-branch-name>
Commit Changes: Verify that all intended changes are committed.
git status to check for unstaged or uncommitted changes.maingit add .
git commit -m "type(scope): description"
Locate Template: Search for a pull request template in the repository.
.github/pull_request_template.md.github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE/),
ask the user which one to use or select the most appropriate one based on
the context (e.g., bug_fix.md vs feature.md).Read Template: Read the content of the identified template file.
Draft Description: Create a PR description that strictly follows the template's structure.
[x] if completed. If an item
is not applicable, leave it unchecked or mark as [ ] (depending on the
template's instructions) or remove it if the template allows flexibility
(but prefer keeping it unchecked for transparency).Preflight Check: Before creating the PR, run the workspace preflight script to ensure all build, lint, and test checks pass.
npm run preflight
If any checks fail, address the issues before proceeding to create the PR.
Push Branch: Push the current branch to the remote repository.
CRITICAL SAFETY RAIL: Double-check your branch name before pushing.
NEVER push if the current branch is main.
# Verify current branch is NOT main
git branch --show-current
# Push non-interactively
git push -u origin HEAD
Create PR: Use the gh CLI to create the PR. To avoid shell escaping
issues with multi-line Markdown, write the description to a temporary file
first.
# 1. Write the drafted description to a temporary file
# 2. Create the PR using the --body-file flag
gh pr create --title "type(scope): succinct description" --body-file <temp_file_path>
# 3. Remove the temporary file
rm <temp_file_path>
feat(ui): add new button,
fix(core): resolve crash).main. This is your highest priority.