Skip to content

README.md

Latest commit

 

History

History
98 lines (66 loc) · 2.9 KB

README.md

File metadata and controls

98 lines (66 loc) · 2.9 KB

explain-this-pr

explain-this-pr

Point this skill at any GitHub PR and it writes a plain-English explanation of what changed and why, then posts it as a PR comment.

Install

npx "@opendirectory.dev/skills" install explain-this-pr --target claude

Video Tutorial

Watch this quick video to see how it's done:

install-skill-on-claude-compress.mp4

Step 1: Download the skill from GitHub

  1. Copy the URL of this specific skill folder from your browser's address bar.
  2. Go to download-directory.github.io.
  3. Paste the URL and click Enter to download.

Step 2: Install the Skill in Claude

  1. Open your Claude desktop app.
  2. Go to the sidebar on the left side and click on the Customize section.
  3. Click on the Skills tab, then click on the + (plus) icon button to create a new skill.
  4. Choose the option to Upload a skill, and drag and drop the .zip file (or you can extract it and drop the folder, both work).

Note: For some skills (like position-me), the SKILL.md file might be located inside a subfolder. Always make sure you are uploading the specific folder that contains the SKILL.md file!

What It Does

  • Fetches the PR diff and metadata via gh
  • Writes two paragraphs: what changed (technical) and why it matters (impact)
  • Posts the explanation as a PR comment with gh pr comment
  • Works with any public or private repo you have access to via gh

Requirements

Requirement Purpose How to Set Up
gh CLI Fetching PR data and posting comments https://cli.github.com, then run gh auth login

No API keys needed.

How to Use

Explain a PR by URL:

"Explain this PR: https://github.com/owner/repo/pull/123"
"What does this PR do? https://github.com/owner/repo/pull/456"
"Summarize this pull request: [URL]"

Explain by PR number (in the current repo):

"Explain PR #42"
"Add a summary comment to PR #99"

Explain the current branch PR:

"Explain the current branch PR"
"Add a plain-English comment to my PR"

Output without posting:

"Explain this PR but don't post the comment: [URL]"
"What does this PR change? Just give me the text."

Output Format

Two paragraphs, under 150 words total.

Paragraph 1: What it does (technical). Names the specific files, functions, or systems that changed. States the before/after if visible in the diff.

Paragraph 2: Why it matters (impact). Explains who benefits and what problem is solved. Omitted if there is no clear "why" in the diff or commits. The skill never guesses at impact.

Project Structure

explain-this-pr/
├── SKILL.md
├── README.md
└── evals/
    └── evals.json

License

MIT