ai-pr-desc_skill

Overview

This skill generates clear, structured pull request descriptions automatically from your Git changes. It reads diffs on the current branch or between two refs and produces sections like What, Why, Changes, Testing, and Breaking Changes to save time and standardize PR text.

How this skill works

The tool inspects the git diff for your branch or a specified base/head comparison, extracts changed files and code intent, and uses a language model to produce a human-readable PR description. It highlights key additions, removals, rationale, testing steps, and any breaking changes, and can output to stdout or copy to the clipboard.

When to use it

• When creating a new pull request and you want a fast, consistent description
• When opening many small PRs and you need to standardize descriptions
• When you want to include testing steps and breaking-change notes automatically
• When preparing a PR for reviewers who need a concise summary
• When comparing two branches to produce a ready-made PR body

Best practices

• Run from a git repository with your changes committed or staged for accurate diffs
• Set OPENAI_API_KEY in your environment and use Node.js 18+ as required
• Review and edit generated text to add context specific to product or business rules
• Use flags to compare specific refs (base/head) or include screenshots placeholders
• Pipe output into your clipboard or CI job to automate PR creation

Example use cases

• Generate a PR description for a feature branch adding authentication endpoints
• Create a clear changelog-style PR for a bugfix branch that touches multiple modules
• Produce testing instructions and highlight breaking API changes for reviewers
• Compare main and feature branches in CI to auto-populate PR bodies
• Copy generated description to clipboard before opening the PR in the web UI