PR Description Format

VerifiedSafe

Provides PR description format and workflow requirements for GitHub pull requests.

Sby Skills Guide Bot
DevelopmentBeginner
7/26/2026
Claude Code
#pull-requests#github#gh-cli#workflow#japanese

Recommended for

Automated summary

Enforces a GitHub pull request description format (summary / background / change details) and a draft-first workflow via the gh CLI, with descriptions written in plain-form Japanese.

Strengths

  • Gives a clear three-section template covering what changed, why, and implementation details
  • Checks for an existing repository PR template first and defers to it instead of the built-in format
  • Covers the PR lifecycle: create as draft, mark ready on request, and refresh the body on new commits

Limitations

  • Assumes the gh CLI is installed and authenticated against the repository
  • Mandates Japanese plain form (だ/である), which will not fit every project
  • Does not address code review, commit conventions, or label management
When to use it

Use it when writing or updating a GitHub pull request description that needs a consistent, structured body and draft-first flow.

When not to use it

Skip it for repositories that require PR descriptions in another language or a different mandated format.

Security analysis

Safe
Quality score88/100

The skill only instructs using GitHub CLI commands (gh pr create, gh pr ready, gh pr edit) for legitimate PR management. No destructive, exfiltrating, or obfuscated actions are present. Although it uses network-capable commands, the purpose is benign and standard developer workflow.

No concerns found

How this analysis is made

Examples

Create a draft PR
Create a draft PR for my current branch with a Japanese description in the What/Why/How format. If the repo has a PR template, use that instead.
Refresh the PR body
I just pushed two more commits to this PR — update the description so it matches the current state of the changes.
Mark PR ready
The draft PR looks good now, mark it as ready for review.

name: pr-description-format description: Provides PR description format and workflow requirements for GitHub pull requests. Use this skill when creating PRs or using 'gh pr create'.

PR Description Format

Instructions

Important Notes

  • Do not use roleplay; use normal professional tone.
  • If "Why" is unclear, ask user before creating PR.
  • PR descriptions should be written in Japanese using plain form (だ/である/体言止め style), not polite form (です/ます style).
  • Always check if the repository has a PR template first (common locations: .github/PULL_REQUEST_TEMPLATE.md, .github/pull_request_template.md, PULL_REQUEST_TEMPLATE.md, docs/PULL_REQUEST_TEMPLATE.md). If a template exists, use that template instead of the format provided below.

Workflow Requirements

  1. Always start with Draft PR: gh pr create --draft
  2. Switch to open only when requested: gh pr ready
  3. Update description on new commits: gh pr edit --body to reflect current state

Examples

Format: What / Why / How

## 概要
[変更内容の簡潔な要約]

## 変更の背景
[なぜこの変更が必要だったか]

## 変更詳細
- [具体的な変更内容と実装の詳細]

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/pr-description-format-ms1aw5i4/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/pr-description-format-ms1aw5i4' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/pr-description-format-ms1aw5i4/download' --output '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md.part' && mv '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md.part' '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md' && test -s '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/pr-description-format' && cp -R '.skill-downloads/pr-description-format-ms1aw5i4' '.claude/skills/pr-description-format'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/pr-description-format-ms1aw5i4'

openskills read 'pr-description-format-ms1aw5i4'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/pr-description-format-ms1aw5i4/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills