← Back to Skills Marketplace
PR Description
by
Xudong Guo
· GitHub ↗
· v1.1.3
· MIT-0
142
Downloads
1
Stars
0
Active Installs
5
Versions
Install in OpenClaw
/install pr-description
Description
Automatically generate a structured, high-quality Pull Request (PR) description based on the provided git diff or code changes. Trigger when the user asks to...
Usage Guidance
This skill appears to do what it says (generate PR descriptions and optionally update PRs), but it has an important metadata/instruction mismatch: SKILL.md expects git and the GitHub CLI ('gh') and will query your gh authentication, yet the package declares no required binaries or credentials. Before installing or running it, consider:
- Confirm you are comfortable with the agent running local 'git' and 'gh' commands and that your 'gh' is authenticated; those commands will use your GitHub credentials if present.
- Prefer to provide diffs inline (paste the git diff) instead of granting the skill permission to fetch or edit remote PRs.
- Ask the maintainer to update the skill metadata to list required binaries (git, gh) and to explicitly state the credential implications.
- Ensure the agent asks you for explicit approval before performing 'gh pr edit' (SKILL.md says it will — verify that behavior).
If you want to proceed but want lower risk, only use the skill in read-only mode (give it diffs or PR content yourself) and do not allow it to run remote-editing commands.
Capability Assessment
Purpose & Capability
The skill claims to fetch diffs and optionally update PRs via the GitHub CLI and local git; that functionality is coherent with a PR-description generator. However, the registry metadata lists no required binaries or environment variables even though the runtime instructions explicitly instruct use of 'gh' and 'git' and to check 'gh' authentication. This mismatch (declared requirements = none vs. instructions requiring CLI tools and authenticated access) is inconsistent and should be clarified.
Instruction Scope
SKILL.md instructs the agent to run commands like 'gh pr diff', 'gh pr view --json viewerCanUpdate', 'gh api user', and (with explicit user approval) 'gh pr edit ... --body-file <temp-file>'. These steps are within the stated purpose but involve accessing local CLI tools, checking auth state, writing temp files, and (if approved) modifying remote PRs. The skill correctly warns about not executing code found in diffs and requires user confirmation before editing, but the instructions give the agent broad ability to run local commands and interact with GitHub credentials — behavior that should be explicitly declared in the metadata and presented to the user beforehand.
Install Mechanism
This is instruction-only (no install spec), which is low-risk in itself because no new code is written to disk. However, the SKILL.md expects existing tools (git, gh) on PATH; that expectation is not declared in the registry metadata. No external downloads or installs are specified.
Credentials
The skill does not declare any required environment variables or primary credential, yet it instructs the agent to call 'gh' and 'gh api user' and to check viewerCanUpdate, which implicitly uses the user's GitHub authentication (oauth token or local gh auth). That means the skill will rely on credentials accessible to the 'gh' CLI. Because these credentials are not declared or scoped in the metadata, it's unclear what secrets the skill will access and why; this mismatch is a notable risk.
Persistence & Privilege
always:false and default autonomous invocation are present; no install-time persistence or forced inclusion. The skill does include logic to update PRs only after explicit user approval, which limits privileged actions. There is no evidence it modifies other skills or system-wide settings.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install pr-description - After installation, invoke the skill by name or use
/pr-description - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.1.3
- Expanded the skill’s trigger conditions to always activate when a GitHub PR URL or number is provided, ensuring consistent PR description generation for PR links.
- Clarified instructions for checking user permission to edit PRs, including guidance for unauthenticated GitHub CLI situations.
- Updated process for updating PR descriptions: requires user approval, and mandates the PR title be excluded from the body text file when updating via GitHub CLI.
- Ensured output of the PR description even when the user lacks edit permission, with clearer prompts for the next action.
- No file changes; documentation and behavioral logic only.
v1.1.2
- Clarified the PR update process: now, after generating the PR title/description, the user reviews the content before being asked about updating the PR.
- Added instruction to stop and wait for the user's response after outputting generated content, before asking for update approval.
- Updated permission check and user interaction sequence to improve review workflow and prevent unintended updates.
- No code or file changes; documentation/process update only.
v1.1.1
- Clarified instructions for proposing PR updates to existing pull requests.
- Added explicit permission checking using the GitHub CLI (`gh pr view --json viewerCanUpdate`) before offering to update the PR.
- Improved the update flow to ensure permission checks precede user prompts and actions.
- No file or functionality changes outside of documentation improvements.
v1.1.0
- Added instructions to allow fetching code changes via `gh` CLI or local `git` commands when the user provides a PR number, branch name, or requests the current branch.
- Introduced a step to verify user permissions before offering to update a PR description/title and to only proceed with explicit user approval.
- Described the process for updating PRs using the GitHub CLI, including writing descriptions to a temporary file and extracting the generated title.
- Emphasized not to execute any PR update commands without direct user consent.
- Clarified that the user may provide either a raw `git diff` or a text description of changes.
v1.0.0
Initial release of pr-description skill:
- Automatically generates structured, high-quality Pull Request (PR) descriptions from provided git diffs or change summaries.
- Detects user language (English or Chinese) and formats output accordingly.
- Always uses a professional, detailed Markdown PR description template.
- Does not fetch code from external sources or execute any code for security reasons.
- Includes clear guidelines for analyzing changes and categorizing by type (bug fix, new feature, breaking change, etc.).
- Provides instructions and security warnings to ensure safe, responsible use.
Metadata
Frequently Asked Questions
What is PR Description?
Automatically generate a structured, high-quality Pull Request (PR) description based on the provided git diff or code changes. Trigger when the user asks to... It is an AI Agent Skill for Claude Code / OpenClaw, with 142 downloads so far.
How do I install PR Description?
Run "/install pr-description" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is PR Description free?
Yes, PR Description is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does PR Description support?
PR Description is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created PR Description?
It is built and maintained by Xudong Guo (@sunny0826); the current version is v1.1.3.
More Skills