write-pr-description

Writes type-specific PR descriptions for experiments, features, bug fixes, and default changes.

3|Updated Feb 15, 2025
One-click install
npx skills add https://github.com/mark-torres10/ai_tools --skill write-pr-description-mark-torres10
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-pr-description
Source: https://github.com/mark-torres10/ai_tools/tree/main/skills/write-pr-description
Command: npx skills add https://github.com/mark-torres10/ai_tools --skill write-pr-description-mark-torres10

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Drafting pull request descriptions is inconsistent and time-consuming, and different PR kinds (experiments, features, bug fixes) need different structures. This Skill classifies the PR type and drafts a complete, paste-ready description using the matching guide, template, and examples. ## Core Features & Use Cases - Type-Based Routing: Classifies the PR as experiment, feature, bug, or default, then follows that type's dedicated guide and template. - Structured Outlines: Enforces proven section outlines (Summary, Purpose, Architecture, Reproduction, Results, How to verify) with Mermaid diagrams where relevant. - Curated Examples: Provides real example descriptions per type to match tone and shape. - Use Case: After finishing an ablation experiment, ask for a PR description and receive a complete experiment record with setup, flow diagram, run command, and results table ready to paste into GitHub. ## Quick Start Ask the assistant to write a PR description for your current diff or experiment, mentioning whether it is a feature, bug fix, or experiment.

Frequently Asked Questions about write-pr-description

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

FAQPage Schema
How do I write a good PR description for a bug fix?

A bug fix PR description should state what is broken, how to reproduce it, the root cause, what the fix changes, and how to verify it. This Skill routes bug PRs to a dedicated guide covering Summary, Purpose, Reproduction, Root cause, Fix, and How to verify sections.

How do I write a PR description for an ML experiment?

An experiment PR description acts as a compact experiment record covering what was tested, why, the setup, a Mermaid flow diagram, the run command, and a results table. This Skill provides an experiment guide, template, and three worked examples including ablations and model comparisons.

What sections should a feature PR description include?

A feature PR description should include a Summary, Purpose, Architecture with before/after Mermaid diagrams, Interfaces and contracts (endpoints, schemas, configuration), and How to run instructions. The Skill's feature guide and template define each section with examples.

What if my PR is not a feature, bug, or experiment?

Use the default type, a catch-all for refactors, chores, infra changes, docs, and dependency bumps. Its guide structures the description around Problem, Solution, Purpose, and How to run sections.

Does this Skill support diagrams in PR descriptions?

Yes, the guides call for Mermaid flowchart diagrams where they clarify the change. Feature PRs use before/after architecture diagrams, experiment PRs use pipeline flow diagrams, and bug fixes use before/after diagrams when control flow changes.