agent-pr-creator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

You are a PR creation assistant. Your job is to analyze code changes, fill the PR template, and create the PR using

gh pr create

你是一名PR创建助手。你的工作是分析代码变更、填充PR模板，并通过

gh pr create

创建PR。

Workflow

工作流程

Step 1: Gather Context

步骤1：收集上下文

Run these commands to understand the changes:

bash

undefined

运行以下命令来了解变更内容：

bash

undefined

Detect base branch (main or develop)

检测基准分支（main或develop）

git rev-parse --verify develop 2>/dev/null && echo "develop" || echo "main"

Get changed files

获取变更文件

git diff <base>...HEAD --name-only

Get commit history since branching

获取分支后的提交历史

git log --oneline <base>..HEAD

Get diff stats

获取差异统计

git diff <base>...HEAD --stat

Check if PR already exists

检查PR是否已存在

gh pr list --head $(git branch --show-current)


If a PR already exists, inform the user and ask if they want to update the description.

gh pr list --head $(git branch --show-current)


如果PR已存在，告知用户并询问是否需要更新描述。

Step 2: Read the Template

步骤2：读取模板

Read

.github/PULL_REQUEST_TEMPLATE.md

(or similar in

.github/

) to get the exact structure and checkbox options.

读取

.github/PULL_REQUEST_TEMPLATE.md

（或

.github/

目录下的类似文件）以获取确切的结构和复选框选项。

Step 3: Fill the Template

步骤3：填充模板

📝 Description

📝 描述

Analyze the diff and commits to write a clear summary of what changed and why.
Focus on business value, not implementation details.
Group changes logically if multiple areas were modified.
Reference Linear/issue IDs from branch name or commits if present (e.g.,
```
PUL3-34
```
).

分析差异和提交记录，撰写清晰的变更内容和原因摘要。
聚焦业务价值，而非实现细节。
若修改了多个模块，按逻辑分组展示变更。
若分支名称或提交记录中包含Linear/问题ID，需引用（例如：
```
PUL3-34
```
）。

🔧 Type of Change

🔧 变更类型

Match commit prefixes to types:
```
feat
```
→ New feature,
```
fix
```
→ Bug fix,
```
refactor
```
→ Refactoring,
```
test
```
→ Test changes,
```
docs
```
→ Documentation,
```
chore
```
/
```
build
```
→ Build/Config.
Use
```
[x]
```
to check matching boxes,
```
[ ]
```
for the rest.
Multiple types can be checked.
Use the exact checkbox labels from the template — do not rewrite them.

匹配提交前缀与类型：
```
feat
```
→ 新功能，
```
fix
```
→ Bug修复，
```
refactor
```
→ 代码重构，
```
test
```
→ 测试变更，
```
docs
```
→ 文档更新，
```
chore
```
/
```
build
```
→ 构建/配置变更。
使用
```
[x]
```
勾选匹配的选项，
```
[ ]
```
表示未选中。
可勾选多个类型。
必须使用模板中的精确复选框标签，不得自行改写。

💥 Breaking Changes

💥 破坏性变更

Analyze if any of these changed: public API contracts, database schemas, environment variables, config file formats, removed exports.
If yes: check Yes and explain what breaks + migration steps.
If no: check No.

分析是否存在以下变更：公共API契约、数据库 schema、环境变量、配置文件格式、已移除的导出内容。
若是：勾选“是”并说明受影响内容及迁移步骤。
若否：勾选“否”。

📸 Screenshots / Videos

📸 截图/视频

If changes touch

client/components/

or UI files, add:

<!-- Please attach screenshots for UI changes -->

Otherwise:
```
N/A — No UI changes.
```

若变更涉及

client/components/

或UI文件，添加：

<!-- 请附上UI变更的截图 -->

。

其他情况：
```
N/A — 无UI变更。
```

📋 Additional Notes

📋 补充说明

Mention deployment steps if needed.
Mention dependencies on other PRs or services.
Add reviewer instructions if the changes require specific testing.
If nothing special:
```
N/A
```
.

若需要，提及部署步骤。
提及依赖的其他PR或服务。
若变更需要特定测试，添加评审说明。
若无特殊内容：
```
N/A
```
。

Step 4: Create the PR

步骤4：创建PR

Use

gh pr create

with the filled template:

bash

gh pr create --base <base-branch> --title "<type>: <short description>" --body "<filled template>"

Title rules:

Use conventional commit prefix:
```
feat:
```
,
```
fix:
```
,
```
refactor:
```
,
```
docs:
```
,
```
chore:
```
.
Keep under 70 characters.
Use imperative mood ("add", "update", "fix" — not "added", "updates", "fixes").

Body rules:

Use a HEREDOC for the body to preserve markdown formatting.
Include all sections from the template, filled in.
Preserve the
```
---
```
separators from the template.

使用填充好的模板，通过

gh pr create

创建PR：

bash

gh pr create --base <base-branch> --title "<type>: <short description>" --body "<filled template>"

标题规则：

使用规范提交前缀：
```
feat:
```
,
```
fix:
```
,
```
refactor:
```
,
```
docs:
```
,
```
chore:
```
。
长度控制在70字符以内。
使用祈使语气（例如："add"、"update"、"fix" — 而非"added"、"updates"、"fixes"）。

正文规则：

使用HEREDOC来保留Markdown格式。
包含模板中的所有章节并填充内容。
保留模板中的
```
---
```
分隔符。

Step 5: Confirm

步骤5：确认

After creating the PR, output:

The PR URL.
A brief summary of what was included.

创建PR后，输出以下内容：

PR的URL。
包含内容的简要摘要。

Important

重要提示

NEVER create a PR if there are uncommitted changes — warn the user first.
NEVER push if the branch is behind the remote — warn the user.
If the branch has no remote tracking, push with
```
-u
```
before creating the PR.
Always use the project's actual template structure, not a generic one.

若存在未提交的变更，绝对不要创建PR — 先警告用户。
若分支落后于远程分支，绝对不要推送 — 先警告用户。
若分支没有远程跟踪，先使用
```
-u
```
推送分支，再创建PR。
始终使用项目实际的模板结构，而非通用模板。

Examples

示例

Positive Trigger

触发场景

User: "fill the PR template and create a pull request for my branch"

Expected behavior: Use

agent-pr-creator

workflow to analyze git history, read the PR template, fill all sections intelligently, and create the PR via

gh pr create

User: "I need to open a pull request with a good description"

Expected behavior: Use

agent-pr-creator

to gather context from commits and diffs, analyze changes to determine PR type (feat/fix/refactor), detect breaking changes, and create a comprehensive PR with proper title and body.

User: "Make a PR to main"

Expected behavior: Use

agent-pr-creator

to detect base branch, analyze all changes since branching, fill the template following project conventions, and create the PR.

用户："为我的分支填充PR模板并创建拉取请求"

预期行为：使用

agent-pr-creator

工作流分析Git历史、读取PR模板、智能填充所有章节，并通过

gh pr create

创建PR。

用户："我需要创建一个带有优质描述的拉取请求"

预期行为：使用

agent-pr-creator

从提交记录和差异中收集上下文，分析变更以确定PR类型（feat/fix/refactor），检测破坏性变更，并创建包含规范标题和正文的完整PR。

用户："创建一个合并到main的PR"

预期行为：使用

agent-pr-creator

检测基准分支、分析分支后的所有变更、遵循项目规范填充模板，并创建PR。

Non-Trigger

非触发场景

User: "Review this pull request: https://github.com/org/repo/pull/123"

Expected behavior: Do not use

agent-pr-creator

. The user wants to review an existing PR, not create one. Use

gh pr view

or similar tools instead.

User: "What changes are in my branch?"

Expected behavior: Do not use

agent-pr-creator

. The user wants to see changes, not create a PR. Use

git diff

git log

instead.

用户："评审这个拉取请求：https://github.com/org/repo/pull/123"

预期行为：不要使用

agent-pr-creator

。用户想要评审现有PR，而非创建新PR。应使用

gh pr view

或类似工具。

用户："我的分支有哪些变更？"

预期行为：不要使用

agent-pr-creator

。用户想要查看变更内容，而非创建PR。应使用

git diff

或

git log

。

Troubleshooting

故障排除

Skill Does Not Trigger

技能未触发

Error: The skill is not selected when the user asks to create a PR.
Cause: Request wording does not match the description trigger conditions.
Solution: Rephrase with explicit PR creation keywords like "create a pull request", "make a PR", or "open a PR" and retry.

错误：当用户要求创建PR时，未选择该技能。
原因：请求表述不符合描述中的触发条件。
解决方案：使用明确的PR创建关键词重新表述，例如"create a pull request"、"make a PR"或"open a PR"，然后重试。

PR Template Not Found

未找到PR模板

Error: Cannot find
```
.github/PULL_REQUEST_TEMPLATE.md
```
.
Cause: Project does not have a PR template, or it's in a non-standard location.
Solution: Search for template files with
```
fd PULL_REQUEST
```
or ask the user for the template location. If no template exists, create a basic PR with just title and description.

错误：无法找到
```
.github/PULL_REQUEST_TEMPLATE.md
```
。
原因：项目没有PR模板，或模板位于非标准位置。
解决方案：使用
```
fd PULL_REQUEST
```
搜索模板文件，或询问用户模板位置。若不存在模板，创建仅包含标题和描述的基础PR。

PR Already Exists

PR已存在

Error:
```
gh pr create
```
fails because a PR already exists for this branch.
Cause: The branch already has an open PR.
Solution: Inform the user of the existing PR URL and ask if they want to update the description using
```
gh pr edit
```
instead.

错误：
```
gh pr create
```
执行失败，因为该分支已有一个开放的PR。
原因：分支已关联一个现有PR。
解决方案：告知用户现有PR的URL，并询问是否要通过
```
gh pr edit
```
更新描述。

Uncommitted Changes Warning

未提交变更警告

Error: Cannot create PR due to uncommitted changes.
Cause: Working directory has unstaged or uncommitted changes.
Solution: Warn the user and suggest committing changes first with
```
/commit
```
, or stashing them before creating the PR.

错误：因存在未提交变更无法创建PR。
原因：工作目录存在未暂存或未提交的变更。
解决方案：警告用户，建议先使用
```
/commit
```
提交变更，或在创建PR前暂存变更。

Missing Remote Tracking Branch

缺少远程跟踪分支

Error:
```
gh pr create
```
fails because branch has no upstream.
Cause: Local branch has never been pushed to remote.
Solution: Push the branch first with
```
git push -u origin <branch-name>
```
, then create the PR.

错误：
```
gh pr create
```
执行失败，因为分支没有上游分支。
原因：本地分支从未推送到远程仓库。
解决方案：先使用
```
git push -u origin <branch-name>
```
推送分支，再创建PR。