OpenParable
Skip to content
← Back to skills

Commit PR

Development
commit-pr

Commit PR is an Agent Skill for development published in the videojs/v10 repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Commit all changes and create or update a PR following project conventions. Triggers: "commit and pr", "push changes", "create pull request".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/videojs/v10/blob/HEAD/.claude/skills/commit-pr/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/commit-pr, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Commit & PR

Stage all changes, create a conventional commit, and open a pull request (or push to an existing one).

Usage

/commit-pr [refs]
  • refs (optional): Issue/PR references (e.g., #123, fixes #456, closes #789)

Examples

/commit-pr
/commit-pr #123
/commit-pr fixes #456
/commit-pr #123 closes #456

Arguments

$ARGUMENTS

Conventions

Load the git skill for:

  • Commit message format (references/commit.md)
  • Scope inference (references/scope.md)
  • PR title and body template (references/pr.md)

Your Tasks

Step 1: Load Conventions

Load the git skill to understand commit and PR conventions.

Step 2: Analyze Changes

  1. Run git status to identify changed files
  2. Run git diff --staged and git diff to understand what changed
  3. Read modified files if needed for context

Step 3: Determine Commit Type and Scope

Based on the changes and git skill conventions:

  • Type: What kind of change? (feat/fix/chore/refactor/docs/test/etc)
  • Scope: Which package or area? (infer from file paths per references/scope.md)
  • Breaking: Does it break existing behavior? (use ! suffix)

Step 4: Create Commit

  1. Stage all changes: git add -A
  2. Create commit with conventional message:
    git commit -m "type(scope): description"
    

Step 5: Push and Create/Update PR

  1. Push branch to remote: git push -u origin HEAD

  2. Check if a PR already exists for this branch:

    gh pr list --head "$(git branch --show-current)" --json number,url,title,body --jq '.[0]'
    
  3. If PR exists:

    • Ask the user if they want to update the PR description (use the question tool)
    • If yes: Generate new body based on all commits in the PR, then update:
      gh pr edit <number> --body "new body"
      
      Note: Only update the body, never the title.
    • If no: Skip — the push already updated the PR code
  4. If no PR exists: Create one using gh pr create:

    gh pr create --title "type(scope): description" --body "$(cat <<'EOF'
    ## Summary
    
    ...
    EOF
    )"
    

    Follow the PR body template from references/pr.md.

Step 6: Report

  • Existing PR (no update): "Pushed to PR #123: "
  • Existing PR (updated): "Updated PR #123: "
  • New PR: "Created PR #123: "

Writing Clear PR Descriptions

A reviewer should understand the PR in 30 seconds. Apply the same rigor as issue bodies:

  • Why over what -- explain motivation, not mechanics. The diff shows what changed.
  • Be concise -- cut filler. Every sentence should carry information.
  • No file lists -- reviewers see the diff. Describe behavior changes.
  • Collapse details -- use <details> for implementation notes, tradeoffs, or architecture decisions that only some reviewers need.
  • Sections must earn their place -- omit Testing if covered by existing tests with nothing to add. Omit Changes if the summary says it all.
  • Don't repeat the title in the summary.

Important

  • Always stage ALL changes with git add -A
  • Always check for existing PR before creating -- avoid duplicate PRs
  • Prefer gh CLI for GitHub operations; fallback to MCP tools if gh unavailable