pr-writer

Generate GitHub pull request titles and bodies following conventional commit conventions.

70|42|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/tranhieutt/software_development_department --skill pr-writer-tranhieutt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-writer
Source: https://github.com/tranhieutt/software_development_department/tree/main/.claude/skills/pr-writer
Command: npx skills add https://github.com/tranhieutt/software_development_department --skill pr-writer-tranhieutt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains disciplined pull request creation by enforcing conventional commit titles, structured descriptions, and issue references so PRs never land without documented intent or context.

Core Features & Use Cases

  • Branch validation: Guides git status, git log, and gh repo view commands to confirm a clean, rebased branch before opening or updating a PR.
  • Description framework: Defines the narrative of what, why, alternatives considered, and reviewer context while explicitly excluding test plan checklists or redundant summaries.
  • Title and creation tooling: Teaches conventional commit-style titles and how to run gh pr create or gh api updates to draft, edit, or finalize the PR.

Quick Start

Use this skill to compose a PR title and body that follow conventional commit rules before running gh pr create.

Frequently Asked Questions about pr-writer

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

FAQPage Schema
How do I create a pull request with conventional commit titles using GitHub CLI?

To create a pull request with conventional commit titles, draft a structured title and body following conventional commit rules, then execute gh pr create via GitHub CLI. This enforces consistent PR documentation and standardized review context across collaborative repositories.

What should be included in a structured pull request description?

A structured pull request description must define what the change does, why it is needed, alternatives considered, and reviewer context. It deliberately excludes test plan checklists and redundant summaries to maintain disciplined, focused PR documentation.

Do I need a clean git branch state before opening a pull request?

Yes, a clean, rebased branch state is required before opening a pull request. Branch validation leverages git status, git log, and gh repo view commands to confirm readiness, ensuring PRs land without undocumented changes or merge conflicts.

How do I update an existing GitHub pull request body and title?

Updating an existing GitHub pull request body and title requires running gh api update commands after composing conventional commit-compliant text. This modifies documented intent and reviewer context on open PRs without creating new pull requests.

Does this pull request creation workflow require GitHub CLI authentication?

Yes, GitHub CLI authenticated access is required for this pull request creation workflow. It leverages gh pr create and gh api commands to draft, edit, or finalize PRs while enforcing conventional commit conventions and documented description structures.

What are the limitations of enforcing conventional commits on pull requests?

Limitations of enforcing conventional commits on pull requests include the exclusion of test plan checklists and redundant summaries, focusing strictly on documented intent. It also requires manual guidance for drafting titles and descriptions rather than fully automating PR generation.