Pr Update Description

Update a PR with a clear explanation of the changes. Use when the user asks to update, write, or improve a PR description, or mentions "pr description", "update PR", or "describe PR".

amitkot c11fa3f 1.3 KB Updated

File contents

Update PR Description

Determine the PR number from the user's message, current branch, or by running gh pr view --json number.

Update the PR with a clear, concise description and title.

Goal: Help reviewers quickly understand the change before reading code.

Guide your thinking with these questions:

  • Would a reviewer understand what's important and what needs their attention?
  • CRITICAL - A reviewer must understand FROM THE DESCRIPTION:
    • How was this tested?
    • How do we verify this fix worked after deployment?
    • What's the risk level? Does this affect trading, execution, or money flow? If not (logging, docs, DB writes only), say so explicitly - reviewers can skim. If yes, what could go wrong?
    • Where should the reviewer focus? What parts need careful scrutiny vs. a quick glance?
  • For bug fixes: Can they understand in 30 seconds what broke, why it broke, and why we didn't catch it?

Keep it brief. A simple change needs a simple description.

Use gh pr view/diff to understand the changes, then gh pr edit to update both title and body.

Report: brief summary + PR URL.

amitkot/claude-code-tools/tree/main/pr-update-description/skills/pr-update-description commit c11fa3f982

Frequently asked questions

npx skillmds@latest add amitkot/pr-update-description