OpenParable
Skip to content
← Back to skills

Edit PR

Development
edit-pr

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

Edit PR description with structured format

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/AzurIce/ranim/blob/HEAD/.claude/skills/edit-pr/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/edit-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.

Edit the PR description with a structured format following ranim's conventions (reference: PR #77, PR #64).

Task

  1. Identify the PR: If no PR number is provided, get the current branch's PR with gh pr list --head $(git branch --show-current).

  2. Analyze the changes:

    • Run git diff main...HEAD --stat to understand the scope
    • Run git log main..HEAD --oneline to see commits
    • Identify what files/modules were changed
  3. Understand the context: Read key changed files to understand what the PR is doing. Look for:

    • New features or functionality
    • Bug fixes
    • Breaking changes (API changes, removed fields, changed behavior)
    • Refactorings
  4. Structure the PR description following this format:

Closes: #<issue-number>

- **feat**: New features or capabilities
- **fix**: Bug fixes
- **refactor**: Code improvements without behavior change
- **docs**: Documentation updates
- **perf**: Performance improvements
- **test**: Test additions or changes

### Breaking Changes

- **API/Field name**: Description of the breaking change and migration path

---

## Component/Feature 1

Detailed description of the first major change.

Use code blocks, mermaid diagrams, or examples as needed.

## Component/Feature 2

...
  1. Use visualizations when helpful:

    • Mermaid flowcharts for workflows, pipelines, or state machines
    • Code snippets for API changes
    • Before/after comparisons for refactorings
  2. Update the PR with gh pr edit <number> --body "$(cat <<'EOF'\n...\nEOF\n)"

Guidelines

  • Top section: Concise bullet list categorized by change type (feat/fix/refactor/etc)
  • Breaking changes: Always a separate section if any exist
  • Detail sections: Group related changes logically by component/feature
  • Be specific: Focus on "what changed" and "why it matters"
  • Visual aids: Use mermaid diagrams for complex structures (graphs, flows, architectures)
  • Examples over prose: Show examples instead of long explanations
  • Omit noise: Skip implementation details unless they're the point

Return the PR URL at the end.