generate-pr-description

Generate standardized Chinese PR descriptions from git diff output.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/futuretea/x-project --skill generate-pr-description-futuretea
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-pr-description
Source: https://github.com/futuretea/x-project/tree/main/.claude/skills/generate-pr-description
Command: npx skills add https://github.com/futuretea/x-project --skill generate-pr-description-futuretea

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

为代码变更生成结构化、可审阅的中文 Pull Request 描述,减少撰写不规范或信息不全的 PR 文本,提高代码审阅效率并帮助审阅者快速定位关键变更与验证步骤。

Core Features & Use Cases

  • 基于 git diff 输出提取核心变更点,按 Problem / Solution / Test Plan 三段式组织描述,便于审阅者理解改动背景、实现方案与验证流程。
  • 强制格式与语言约束:全文中文、禁止 emoji、Solution 使用无序列表或小标题、Test Plan 使用有序步骤,确保输出一致且可执行。
  • 适用于日常开发提交、代码审查准备以及生成团队规范化 PR 模板的场景,例如在特性分支合并请求前快速生成可复制到 Git 平台的描述内容。

Quick Start

使用当前分支与目标分支的 git diff 输出,生成遵循 Problem/Solution/Test Plan 格式的中文 PR 描述。

Frequently Asked Questions about generate-pr-description

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

FAQPage Schema
How do I generate a standardized Chinese PR description from a git diff?

To generate a standardized Chinese PR description from a git diff, the Skill parses your diff output to identify core functional changes and structures them into a Problem, Solution, and Test Plan format. This ensures concise summaries for code reviewers.

What format does the generated pull request description follow?

The generated pull request description follows a strict three-part format: Problem, Solution, and Test Plan. The Solution section uses unordered lists or subheadings, while the Test Plan uses ordered steps to ensure output consistency and executable verification.

Can I use this to create pull request text for feature branch merges?

Yes, you can use this for feature branch merges. It applies to software engineering workflows where developers prepare pull requests across feature and main/master branches, generating concise, standardized Chinese summaries for reviewers to quickly locate key changes.

Does the generated PR description support emoji and English text?

No, the generated PR description does not support emoji or English text. It enforces strict language and format constraints by outputting Chinese only and prohibiting emoji to maintain a clean, professional, and standardized code review context.

Why do I need a structured Test Plan in my pull request description?

You need a structured Test Plan in your pull request description to provide actionable test steps derived from the git diff. This helps reviewers understand the implementation solution and efficiently verify that the core functional changes work as intended.