Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

pr-description-writer

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 update the PR in one step.

Installation

Prerequisites

You need Node.js installed. It comes with npx built in.

Option 1: npx (All Agents)

npx "@opendirectory.dev/skills" install pr-description-writer --target claude

Supported --target values: claude, gemini, codex, opencode, anti-gravity, openclaw, hermes

Option 2: Native Plugin (Claude Code Only)

Run these two commands inside your Claude Code terminal:

# Add the OpenDirectory marketplace
/plugin marketplace add Varnan-Tech/opendirectory

# Install a skill directly
/plugin install pr-description-writer@opendirectory-marketplace

Option 3: Claude Desktop App

Step 1: Download Click Code → Download ZIP on this repo's GitHub page.

Step 2: Install

  1. Open Claude Desktop > Customize > Skills > + > Upload a skill
  2. Drop the downloaded zip or extracted folder

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, 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

About

Reads a pull request diff and writes a clear description. Covers what changed, why it changed, how to test it, and any risks worth flagging.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors