pr-description

Name: pr-description
Availability: InStock
Author: Blockscout

Generate structured PR descriptions from task artifacts and implementation snapshots.

229|201|Updated May 20, 2022

Search Tags:#workflow #documentation #diff #pr #description #artifact #pull-request

Ready to run

npx skills add https://github.com/blockscout/blockscout-rs --skill pr-description-blockscout

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/blockscout/blockscout-rs/tree/main/interchain-indexer/.cursor/skills/pr-description
Command: npx skills add https://github.com/blockscout/blockscout-rs --skill pr-description-blockscout

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill generates clear, reviewer-friendly PR descriptions from the task artifacts under tmp/tasks/<task-name>/ and the current implementation snapshot, reducing manual drafting time and miscommunication.

Core Features & Use Cases

Converts task artifacts and code diffs into a structured PR description with sections for implementation summary, API changes, environment or configuration changes, migrations, testing, and rollout notes.
Keeps the PR description in sync with the diff and changed files to minimize drift and review delays.
Useful for handoffs and reviews when collaborating across teams or when a repository has an active task workflow.

Quick Start

Provide the task artifacts under tmp/tasks/<task-name> and the current implementation snapshot to generate a draft PR description.

Frequently Asked Questions about pr-description

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

FAQPage Schema

How do I generate a pull request description from code diffs and task artifacts?▼

You generate a PR description by providing task artifacts under tmp/tasks/<task-name>/ and the current implementation snapshot to the skill. It converts diffs, tests, and migrations into a structured draft for reviews.

What sections should a reviewer-friendly PR description include for API and environment changes?▼

A reviewer-friendly PR description should include an implementation summary, API changes, environment or config changes, migrations, testing, and rollout notes. The skill structures these sections automatically from your snapshot.

How do I keep my PR description in sync with changed files and migrations?▼

You keep PR descriptions in sync by generating them directly from the implementation snapshot and task folder. This minimizes drift between the documentation and the actual code diffs or migrations, reducing review delays.

Do I need an active task folder to draft PR descriptions from diffs?▼

Yes, you need an active task folder under tmp/tasks/<task-name>/ containing task artifacts, along with the current implementation snapshot. The skill relies on these to outline summaries and rollout notes accurately.

Can I automate PR description drafting for cross-team handoffs?▼

Yes, you can automate PR description drafting for cross-team handoffs by processing task artifacts and diffs. This provides a consistent format for implementation summaries, migrations, and testing notes, reducing manual effort.