SKILL DOCUMENTATION

PR Description Writer

Generate comprehensive, reviewer-friendly PR descriptions with diagrams, structured test plans, and repo-local workflow context.

Overview

Generate comprehensive, reviewer-friendly PR descriptions with diagrams, structured test plans, and repo-local workflow context.

This skill ships inside the PR Description Writer plugin and can be installed through the Claude Code marketplace or directly in Codex from its skill path.

Parent Surface

Parent docs: PR Description Writer

Related wrapper commands from the parent plugin:

/pr-description-writer:write-pr

When to Use This Skill

Use this Skill when:

quickly while having access to detailed context.

should shape the PR body or creation flow.

This Skill is designed to work with any repository but is especially tuned for Django/Python backends, React frontends, and infrastructure changes.

  • Creating or updating a PR description for a feature branch.
  • The PR has multiple related changes that need clear organization.
  • You want a description that helps reviewers understand the "why" and "what" quickly while having access to detailed context.
  • You're preparing a PR for review and want it to be self-documenting.
  • The repo has local branch, issue-linkage, or PR-readiness conventions that should shape the PR body or creation flow.

Example Prompts

pr-description-writer Skill."

---

  • "Use pr-description-writer to create a PR description for my current branch."
  • "Generate a comprehensive PR description for PR #1234 using the pr-description-writer Skill."
  • "Update the PR description for my feature branch to match our standard format."

Workflow (High Level)

---

Core Principles

Reviewers should understand the PR in 30 seconds from the summary, then dive deeper as needed. Structure content in layers:

Use diagrams, tables, and structured formatting instead of prose where possible:

Every section should answer a reviewer's question:

Never describe only the latest commit. The PR description must reflect:

Before writing or updating a PR, inspect the repo-local harness for workflow conventions that should shape the branch/PR presentation:

If a repo-local convention exists, it should win over generic defaults. If the current branch or PR state appears inconsistent with repo-local conventions, call that out clearly instead of silently normalizing it in the description text.

---

  • Decision trees for conditional logic
  • Flow diagrams for pipelines and processes
  • Tables for feature summaries and comparisons
  • Code blocks for commands and examples
  • "What does this PR do?" → Summary
  • "Why was it done this way?" → Detailed sections with rationale
  • "What files should I focus on?" → Collapsible file lists
  • "How do I test this?" → Test commands + manual steps
  • "Are there breaking changes?" → Explicit callouts
  • All commits in the branch (from base to HEAD)
  • Any uncommitted changes the user plans to include
  • The cumulative effect of all changes together
  • branch naming expectations
  • issue-linkage expectations
  • base-branch expectations
  • whether PRs should default to draft or non-draft ("Ready for review")

Resources

Declared allowed tools:

BashReadGlobGrep

References

  • gh-cli.md

Installation

Switch between Claude Code and Codex, then copy the install command for the runtime you use.

claude plugin marketplace add DiversioTeam/agent-skills-marketplace
claude plugin install pr-description-writer@diversiotech

Invocation:

/pr-description-writer:write-pr