# Create Reviewer-Ready PR Descriptions

Reviewers lose time when pull requests lack context. This skill gathers branch changes and produces structured PR descriptions with summaries, diagrams, file notes, and test plans.

## Install

```bash
npx skillstore add diversioteam/pr-description-writer
```

## Metadata

- Status: approved
- Slug: diversioteam-pr-description-writer
- Skillstore revision: r1
- Version status: missing
- Tree hash: a1bffe2452989113ffcc3c4f0e5ca32ec46ed558a45dd31a8dea70d6a7c2ef48
- Author: DiversioTeam
- GitHub username: DiversioTeam
- License: MIT
- Repository: https://github.com/DiversioTeam/agent-skills-marketplace/tree/main/plugins/pr-description-writer/skills/pr-description-writer
- Ref: c579efd02184f1128d6741d16e6c8d951d7d4208
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, filesystem
- Quality score: 77
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/diversioteam-pr-description-writer
- Manifest: https://skillstore.pages.dev/api/skills/diversioteam-pr-description-writer/manifest

## Capabilities

- Checks whether the current branch already has a GitHub pull request.
- Identifies a base branch from PR metadata, GitHub defaults, remote HEAD, or common branch names.
- Guides collection of commits, diffs, file stats, and uncommitted changes.
- Drafts reviewer-focused Markdown with summaries, diagrams, grouped file notes, and test instructions.
- Provides GitHub CLI examples for creating or updating pull request bodies.

## Use Cases

- Prepare a Feature PR: Turn a feature branch into a clear pull request description with scope, rationale, changed files, and validation steps.
- Standardize Team Reviews: Create consistent PR descriptions that help reviewers scan summaries, diagrams, risks, and test plans quickly.
- Document Infrastructure Changes: Explain configuration, deployment, migration, and rollback details in a structured pull request body.

## Prompt Templates

### Draft Current PR Description

```
Use pr-description-writer to create a PR description for my current branch. Include a summary, changed files, and test plan.
```

### Update an Existing PR

```
Use pr-description-writer to review the existing PR for this branch and produce an updated description that preserves useful context.
```

### Explain a Multi-Part Change

```
Use pr-description-writer to summarize all commits and uncommitted changes from the base branch. Group the work by feature and include reviewer focus areas.
```

### Prepare a Release-Sensitive PR

```
Use pr-description-writer to create a PR description with migration notes, deployment steps, rollback guidance, breaking changes, and validation coverage.
```

## Limitations

- Requires repository access and Git or GitHub CLI context for best results.
- Does not verify test results unless the user runs the tests.
- Generated descriptions need human review for sensitive changes and release language.
- Command examples assume GitHub workflows and may need changes for other platforms.

## Best Practices

- Review generated PR text for private details before publishing.
- Include both automated and manual validation steps when relevant.
- Place breaking changes and deployment steps in visible sections.

## Anti Patterns

- Publishing a generated description without checking accuracy.
- Describing only the latest commit when the branch contains multiple changes.
- Omitting test steps or known risks for complex changes.

## Security Audit

- Audited at: 2026-07-05T13:29:37.621\+00:00
- Summary: Static alerts in SKILL.md are Markdown formatting and documented Git or GitHub CLI examples for collecting PR context and optionally updating PR text. I found no prompt injection, obfuscation, secret exfiltration, or unauthorized command-execution intent. Users should still review generated PR content before publishing it.

## Stats

- Views: 287
- Downloads: 13
- Favorites: 0
- Popularity score: 0