skills.rest
basicmachines-co
basicmachines-coOFFICIAL
Explore all skills by this author →
WebsiteGitHub

pr-description

Writes structured GitHub PR descriptions covering changes, rationale, implementation, and testing.

4.0k|282|Updated Dec 2, 2024
Search Tags:#git#code review#documentation#pull request#github#gh cli#pr description
One-click install
npx skills add https://github.com/basicmachines-co/basic-memory --skill pr-description-basicmachines-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/basicmachines-co/basic-memory/tree/main/.agents/skills/pr-description
Command: npx skills add https://github.com/basicmachines-co/basic-memory --skill pr-description-basicmachines-co

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? PR descriptions are often missing, stale, or too vague for reviewers to understand intent and verify changes. This Skill generates a complete, structured PR body that explains what changed, why, how it was implemented, and how it was tested. ## Core Features & Use Cases - Context Discovery: Uses the GitHub CLI (gh pr view, gh pr diff) and git history to extract intent from commits and changed files. - Structured Body Template: Applies a consistent template with required sections: Why, What Changed, Implementation Details, Testing, and Risks / Follow-ups. - Direct Publishing: Applies the finished body to the PR with gh pr edit and verifies the result. - Use Case: After pushing a feature branch, ask the assistant to write the PR description; it inspects the diff and commits, drafts the body, and publishes it to the open PR. ## Quick Start Write and publish a detailed PR description for the pull request on my current branch using the gh CLI.

Frequently Asked Questions about pr-description

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a good GitHub PR description automatically?▼

Use the GitHub CLI to gather context: run gh pr view for PR metadata, gh pr diff for changed files, and git log for commit intent. Then draft a body with sections for Why, What Changed, Implementation Details, Testing, and Risks, and apply it with gh pr edit --body-file.

How to update an existing PR description with gh CLI?▼

Write the new body to a file such as /tmp/pr-body.md, then run gh pr edit <pr-number> --body-file /tmp/pr-body.md. Afterwards, re-open the PR view to confirm the body and labels were applied correctly.

What sections should a pull request description include?▼

A complete PR body answers five questions: what changed, why the change is needed now, how it was implemented, how it was tested, and what risks or follow-ups remain. Optional sections include Screenshots for UI work, Rollout Notes, and a Reviewer Guide for large diffs.

Does this workflow require the GitHub CLI?▼

Yes, the workflow relies on the gh CLI commands gh pr view, gh pr diff, and gh pr edit, plus standard git log for commit history. You must be authenticated with gh and working in a repository with an active PR for the current branch.

What if some changes in the PR were not tested?▼

State untested work explicitly in the Testing section rather than omitting it. The quality bar requires exact commands run and their outcomes, and any gaps should be listed under Risks / Follow-ups so reviewers know what still needs verification.

Related Skills

Explore More Software Engineering Skills→
MS33834MS33834

Single-Flow PR Yeet

Stages, commits, pushes, and opens a GitHub pull request for a linear change.

Community
Advanced
baasith6baasith6

creating-pr

Automate structured pull request creation with titles, descriptions, issue links, and reviewers.

Community
Intermediate
lucasfcostalucasfcosta
62

general-code-review

Automate code-review of diffs for correctness, simplicity, and test coverage.

Community
Advanced
abnegateabnegate
2

commit

Create Conventional Commits messages from git status and diffs.

Community
Intermediate