pr-draft-summary

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

PR Draft Summary

PR草稿摘要

Purpose

目的

Produce the PR-ready summary required in this repository after substantive code work is complete: a concise change summary plus a PR-ready title and draft description for openai-agents-js.

在完成实质性代码工作后，生成此仓库所需的可提交PR的摘要：包括简洁的变更摘要，以及适用于openai-agents-js的可提交PR的标题和草稿描述。

When to Trigger

触发时机

The task for this repo is finished (or ready for review) and it touched runtime code, tests, examples, docs with behavior impact, or build/test configuration.
You are about to send the "work complete" response and need the PR block included.
Skip only for trivial or conversation-only tasks where no PR-style summary is expected.

此仓库的任务已完成（或准备好评审），且涉及运行时代码、测试、示例、对行为有影响的文档，或构建/测试配置。
您即将发送“工作完成”的回复，且需要包含PR块。
仅在无需PR风格摘要的微小任务或仅对话类任务中跳过此操作。

Inputs to Collect Automatically (do not ask the user)

自动收集的输入（无需询问用户）

Current branch:
```
git rev-parse --abbrev-ref HEAD
```
.
Working tree:
```
git status -sb
```
.

Untracked files:

git ls-files --others --exclude-standard

(use with

git status -sb

;

--stat

omits them).

Changed files:

git diff --name-only

(unstaged) and

git diff --name-only --cached

(staged); sizes via

git diff --stat

and

git diff --stat --cached

Base reference (use the branch's upstream, fallback to

origin/main

BASE_REF=$(git rev-parse --abbrev-ref --symbolic-full-name @{upstream} 2>/dev/null || echo origin/main)

BASE_COMMIT=$(git merge-base --fork-point "$BASE_REF" HEAD || git merge-base "$BASE_REF" HEAD || echo "$BASE_REF")

Commits ahead of the base fork point:

git log --oneline --no-merges ${BASE_COMMIT}..HEAD

Category signals for this repo: runtime (

packages/

examples/

helpers/

scripts/

), tests (

packages/**/test

integration-tests/

), docs (

docs/

README.md

AGENTS.md

.github/

), build/test config (

package.json

pnpm-lock.yaml

pnpm-workspace.yaml

tsconfig*.json

tsc-multi.json

eslint.config.*

vitest*.ts

当前分支：
```
git rev-parse --abbrev-ref HEAD
```
。
工作树状态：
```
git status -sb
```
。
未跟踪文件：
```
git ls-files --others --exclude-standard
```
（与
```
git status -sb
```
配合使用；
```
--stat
```
参数会忽略这些文件）。

已变更文件：

git diff --name-only

（未暂存）和

git diff --name-only --cached

（已暂存）；通过

git diff --stat

和

git diff --stat --cached

查看变更大小。

基准参考（使用分支的上游分支，回退到

origin/main

）：

BASE_REF=$(git rev-parse --abbrev-ref --symbolic-full-name @{upstream} 2>/dev/null || echo origin/main)

。

BASE_COMMIT=$(git merge-base --fork-point "$BASE_REF" HEAD || git merge-base "$BASE_REF" HEAD || echo "$BASE_REF")

。

基准分叉点之后的提交：

git log --oneline --no-merges ${BASE_COMMIT}..HEAD

。

此仓库的分类标识：运行时（

packages/

examples/

helpers/

scripts/

）、测试（

packages/**/test

integration-tests/

）、文档（

docs/

README.md

AGENTS.md

.github/

）、构建/测试配置（

package.json

pnpm-lock.yaml

pnpm-workspace.yaml

tsconfig*.json

tsc-multi.json

eslint.config.*

vitest*.ts

）。

Workflow

工作流程

Run the commands above without asking the user; compute
```
BASE_REF
```
/
```
BASE_COMMIT
```
first so later commands reuse them.
If there are no staged/unstaged/untracked changes and no commits ahead of
```
${BASE_COMMIT}
```
, reply briefly that no code changes were detected and skip emitting the PR block.
Infer change type from the touched paths listed under "Category signals"; classify as feature, fix, refactor, or docs-with-impact, and flag backward-compatibility risk when runtime code changed.
Summarize changes in 1–3 short sentences using the key paths (top 5) and
```
git diff --stat
```
output; explicitly call out untracked files from
```
git status -sb
```
/
```
git ls-files --others --exclude-standard
```
because
```
--stat
```
does not include them. If the working tree is clean but there are commits ahead of
```
${BASE_COMMIT}
```
, summarize using those commit messages.
Choose the lead verb for the description: feature →
```
adds
```
, bug fix →
```
fixes
```
, refactor/perf →
```
improves
```
or
```
updates
```
, docs-only →
```
updates
```
.
Suggest a branch name. If already off
```
main
```
, keep it; otherwise propose
```
feat/<slug>
```
,
```
fix/<slug>
```
, or
```
docs/<slug>
```
based on the primary area (for example
```
docs/pr-draft-summary-guidance
```
).
If the current branch matches
```
issue-<number>
```
(digits only), keep that branch suggestion. When an issue number is present, reference
```
https://github.com/openai/openai-agents-js/issues/<number>
```
and include an auto-closing line such as
```
This pull request resolves #<number>.
```
Do not block if the issue cannot be fetched.
Draft the PR title and description using the template below.
Output only the block in "Output Format". Keep any surrounding status note minimal and in English.

无需询问用户，直接运行上述命令；先计算
```
BASE_REF
```
/
```
BASE_COMMIT
```
，以便后续命令复用。
如果没有暂存/未暂存/未跟踪的变更，且
```
${BASE_COMMIT}
```
之后没有提交，则简要回复未检测到代码变更，跳过生成PR块。
根据“分类标识”中列出的涉及路径推断变更类型；分类为功能新增、修复、重构或有影响的文档变更，当运行时代码变更时标记向后兼容风险。
使用关键路径（前5个）和
```
git diff --stat
```
输出，用1-3个短句总结变更；明确列出
```
git status -sb
```
/
```
git ls-files --others --exclude-standard
```
中的未跟踪文件，因为
```
--stat
```
不包含这些文件。如果工作树干净但
```
${BASE_COMMIT}
```
之后有提交，则使用这些提交信息进行总结。
为描述选择引导动词：功能新增→
```
adds
```
， bug修复→
```
fixes
```
，重构/性能优化→
```
improves
```
或
```
updates
```
，仅文档变更→
```
updates
```
。
建议分支名称。如果当前分支已基于
```
main
```
，则保留；否则根据主要领域建议
```
feat/<slug>
```
、
```
fix/<slug>
```
或
```
docs/<slug>
```
（例如
```
docs/pr-draft-summary-guidance
```
）。
如果当前分支匹配
```
issue-<number>
```
（仅数字），则保留该分支建议。当存在问题编号时，引用
```
https://github.com/openai/openai-agents-js/issues/<number>
```
并添加自动关闭行，例如
```
This pull request resolves #<number>.
```
即使无法获取该问题也无需停滞。
使用以下模板草拟PR标题和描述。
仅输出“输出格式”中的块。保持任何附带的状态说明简洁且使用英文。

Output Format

输出格式

When closing out a task and the summary block is desired, add this concise Markdown block (English only) after any brief status note. If the user says they do not want it, skip this section.

undefined

当完成任务且需要摘要块时，在简短的状态说明后添加此简洁的Markdown块（仅英文）。如果用户表示不需要，则跳过此部分。

undefined

Pull Request Draft

Branch name suggestion

git checkout -b <kebab-case suggestion, e.g., feat/pr-draft-summary-skill>

Title

<single-line imperative title, which can be a commit message; if a common prefix like chore: or feat: etc., having them is preferred>

Description


Keep it tight—no redundant prose around the block, and avoid repeating details between `Changes` and the description. Tests do not need to be listed unless specifically requested.


保持内容紧凑——块周围不要有冗余文字，避免在“变更”和描述之间重复细节。除非特别要求，否则无需列出测试内容。