PR Description Format FAQs

Question 1

How does this skill improve my developer workflow?

Accepted Answer

It automates best practices by starting every PR as a draft, ensuring the rationale for changes is clarified before submission, and automatically updating the PR body whenever new commits are added during the development process.

Question 2

What does the PR Description Format skill do?

Accepted Answer

This skill standardizes the creation of GitHub pull requests by enforcing a structured 'What/Why/How' format. It ensures descriptions are written in professional Japanese (da/dearu style) and integrates directly with the GitHub CLI for workflow management.

Question 3

When should I use this skill?

Accepted Answer

Use this skill whenever you are ready to submit changes to a repository or when using commands like 'gh pr create'. It is ideal for maintaining consistent documentation standards across development teams.

Question 4

What specific GitHub CLI commands does it handle?

Accepted Answer

The skill manages the 'gh pr create --draft' command for initial submissions, 'gh pr edit --body' for keeping documentation in sync with new commits, and 'gh pr ready' for the final transition to review.

Question 5

Does it work with my existing repository PR templates?

Accepted Answer

Yes. The skill automatically searches for existing templates in standard locations (like .github/PULL_REQUEST_TEMPLATE.md). If a template is found, it prioritizes that format over the default internal structure.

PR Description Format

概要

主な機能

ユースケース

PR Description Format

概要

主な機能

ユースケース