| name | pr-creator |
| description | Use this skill when asked to create a pull request (PR). It ensures all PRs follow the repository's established templates and standards. |
Pull Request Creator
This skill guides the creation of high-quality Pull Requests that adhere to the
repository's standards.
Workflow
Follow these steps to create a Pull Request:
-
Locate Template: Search for a pull request template in the repository.
- Check
.github/pull_request_template.md
- Check
.github/PULL_REQUEST_TEMPLATE.md
- If multiple templates exist (e.g., in
.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.
- Headings: Keep all headings from the template.
- Checklists: Review each item. Mark with
[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).
- Content: Fill in the sections with clear, concise summaries of your
changes.
- Related Issues: Link any issues fixed or related to this PR (e.g.,
"Fixes #123").
-
Create PR: Use the gh CLI to create the PR.
gh pr create --title "type(scope): succinct description" --body "..."
- Title: Ensure the title follows the
Conventional Commits format if the
repository uses it (e.g.,
feat(ui): add new button,
fix(core): resolve crash).
Principles
- Compliance: Never ignore the PR template. It exists for a reason.
- Completeness: Fill out all relevant sections.
- Accuracy: Don't check boxes for tasks you haven't done.
