> ## Documentation Index
> Fetch the complete documentation index at: https://www.opendirectory.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# pr-description-writer

> Read your current git branch diff and generate a complete GitHub pull request description: summary, specific change bullets, and testing steps. Create or upd...

<Info>
  **Category:** Developer Tools · **Version:** `1.0.0` · **Author:** `OpenDirectory` · **Compatibility:** All targets (claude, codex, opencode, gemini, anti-gravity, openclaw, hermes)
</Info>

<img width="1280" height="640" alt="pr-description-writer" src="https://github.com/user-attachments/assets/485f5846-b621-40ac-8a99-2b50243fb454" />

Read your current git branch diff and generate a complete GitHub pull request description: summary, specific change bullets, and testing steps. Create or update the PR in one step.

## Install

<Tabs>
  <Tab title="npx CLI (Recommended)">
    ```bash theme={null}
    npx "@opendirectory.dev/skills" install pr-description-writer --target claude
    ```
  </Tab>

  <Tab title="skills.sh">
    ```bash theme={null}
    npx skills add Varnan-Tech/opendirectory --skill pr-description-writer
    ```
  </Tab>

  <Tab title="Claude Code Native">
    ```bash theme={null}
    /plugin marketplace add Varnan-Tech/opendirectory
    /plugin install opendirectory-gtm-skills@opendirectory-marketplace
    ```
  </Tab>

  <Tab title="Claude Desktop">
    <video controls className="w-full aspect-video rounded-xl mb-4" src="https://github.com/user-attachments/assets/cea8b565-2002-4a87-8857-d902bfcfdc1c" />

    1. Copy `https://github.com/Varnan-Tech/opendirectory/tree/main/skills/pr-description-writer` into [download-directory.github.io](https://download-directory.github.io/) to download the ZIP.
    2. Open **Claude Desktop** -> **Customize** -> **Skills** -> **+** -> **Upload a skill** and drop the folder containing `SKILL.md`.
  </Tab>

  <Tab title="Manus AI">
    <video controls className="w-full aspect-video rounded-xl mb-4" src="https://github.com/user-attachments/assets/17cbee2a-9e17-4bd4-ac46-68e0e92ffab4" />

    [**Install pr-description-writer in Manus AI**](https://manus.im/import-skills?githubUrl=https%3A%2F%2Fgithub.com%2FVarnan-Tech%2Fopendirectory%2Ftree%2Fmain%2Fskills%2Fpr-description-writer\&utm_source=opendirectory)
  </Tab>
</Tabs>

## What It Does

* Reads `git diff main...HEAD` to understand what changed
* Reads commit messages for context on why it changed
* Generates a structured PR description following a consistent format
* Creates a new PR with `gh pr create` or updates an existing one with `gh pr edit`

## Requirements

| Requirement | Purpose | How to Set Up |
| - | - | - |
| `gh` CLI | Creating and updating PRs | [https://cli.github.com](https://cli.github.com), then run `gh auth login` |
| Git repo with a branch | Source diff | Run from inside the repo |

No API keys needed. The agent reads the diff directly and writes the description.

## How to Use

Write a description for the current branch:

```
"Write a PR description for my current branch"
"Draft my PR"
"Generate a PR description"
```

Create the PR at the same time:

```
"Create a PR for this branch with a good description"
"Open a PR and write the description"
```

Update an existing PR's description:

```
"Update my PR description"
"Rewrite the PR body based on the latest changes"
```

Output only, no gh commands:

```
"Write a PR description but just give me the text"
"Draft the PR description, I'll paste it myself"
```

## Output Format

Every generated description includes:

| Section | Content |
| - | - |
| Summary | 1-2 sentences on what this PR does and why |
| Changes | Specific bullets, one per logical change, starting with a verb |
| Testing | Actionable steps to verify the change works |
| Screenshots | Only for UI changes |
| Linked Issues | Only if the branch fixes a tracked issue |

## Project Structure

```
pr-description-writer/
├── SKILL.md
├── README.md
├── evals/
│   └── evals.json
└── references/
    └── pr-format-guide.md
```

## License

MIT


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.