write-pr

Generate standardized PR titles and bodies for the tldraw repository.

49.7k|3.4k|Updated May 9, 2021
One-click install
npx skills add https://github.com/tldraw/tldraw --skill write-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-pr
Source: https://github.com/tldraw/tldraw/tree/main/.claude/skills/write-pr
Command: npx skills add https://github.com/tldraw/tldraw --skill write-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

PRs can be inconsistently titled and poorly described, leading to slower reviews and reduced traceability. This Skill standardizes PR titles and bodies to improve clarity and consistency across the tldraw repository.

Core Features & Use Cases

  • Semantic PR titles: Enforce a conventional commits style like feat(scope): description with an optional scope.
  • Structured PR bodies: Provide a body template with sections for Change type, Test plan, Release notes, API changes, and Related issues.
  • Guidance for /pr and related workflows: Assist in drafting guidance that accelerates reviews and collaboration when using PR commands and automation.

Quick Start

Use the write-pr skill to generate a PR title and body for a new change in the tldraw repository.

Frequently Asked Questions about write-pr

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

FAQPage Schema
How do I write a conventional commits style pull request title?

Pull request titles should follow the conventional commits style, formatting as feat(scope): description with an optional scope to categorize the change. This standardizes PR titles to improve clarity and traceability across the repository.

What sections should I include in a PR body template?

A PR body template should include sections for Change type, Test plan, Release notes, API changes, and Related issues. Structuring PR bodies this way provides reviewers with consistent context and accelerates the code review process.

Can I update an existing PR title and body using a structured template?

Yes, you can update existing PR titles or bodies to align with a structured template. This ensures that previously created pull requests conform to conventional commits and contain the required Test plan and Release notes sections.

When do I need to document API changes in a pull request?

You need to document API changes in a pull request when your code modifies the repository's API. The PR template provides specific guidance for detailing these API changes to ensure downstream consumers understand the impact.

Does this PR standardization work for any repository or just specific workflows?

This PR standardization enforces conventional commits and structured bodies specifically for the tldraw repository. It guides PR-related workflows by providing tailored templates to accelerate collaboration within that specific codebase.