Agent skill
pr-draft-summary
Create the required PR-ready summary block, branch suggestion, title, and draft description for openai-agents-js. Use in the final handoff after moderate-or-larger changes to runtime code, tests, examples, build/test configuration, or docs with behavior impact; skip only for trivial or conversation-only tasks, repo-meta/doc-only tasks without behavior impact, or when the user explicitly says not to include the PR draft block.
Install this agent skill to your Project
npx add-skill https://github.com/openai/openai-agents-js/tree/main/.agents/skills/pr-draft-summary
SKILL.md
PR Draft Summary
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.
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.
- Treat this as the default final handoff step for substantive code work. Run it after any required verification or changeset work and before sending the "work complete" response.
- Skip only for trivial or conversation-only tasks, repo-meta/doc-only tasks without behavior impact, or when the user explicitly says not to include the PR draft block.
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 withgit status -sb;--statomits them). - Changed files:
git diff --name-only(unstaged) andgit diff --name-only --cached(staged); sizes viagit diff --statandgit 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).
Workflow
- Run the commands above without asking the user; compute
BASE_REF/BASE_COMMITfirst 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 only when the diff changes released public APIs, external config, persisted data, or wire protocols. Judge that risk against the latest release tag, not unreleased branch-only churn.
- Summarize changes in 1–3 short sentences using the key paths (top 5) and
git diff --statoutput; explicitly call out untracked files fromgit status -sb/git ls-files --others --exclude-standardbecause--statdoes 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 →improvesorupdates, docs-only →updates. - Suggest a branch name. If already off
main, keep it; otherwise proposefeat/<slug>,fix/<slug>, ordocs/<slug>based on the primary area (for exampledocs/pr-draft-summary-guidance). - If the current branch matches
issue-<number>(digits only), keep that branch suggestion. When an issue number is present, referencehttps://github.com/openai/openai-agents-js/issues/<number>and include an auto-closing line such asThis 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.
Output Format
When closing out a task, add this concise Markdown block (English only) after any brief status note unless the task falls under the documented skip cases or the user says they do not want it.
# 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
<include what you changed plus a draft pull request title and description for your local changes; start the description with prose such as "This pull request resolves/updates/adds ..." using a verb that matches the change (you can use bullets later), explain the change background (for bugs, clearly describe the bug, symptoms, or repro; for features, what is needed and why), any behavior changes or considerations to be aware of, and you do not need to mention any tests you ran.>
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.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
openai-knowledge
Use when working with the OpenAI API (Responses API) or OpenAI platform features (tools, streaming, Realtime API, auth, models, rate limits, MCP) and you need authoritative, up-to-date documentation (schemas, examples, limits, edge cases). Prefer the OpenAI Developer Documentation MCP server tools when available; otherwise guide the user to enable `openaiDeveloperDocs`.
final-release-review
Perform a release-readiness review by locating the previous release tag from remote tags and auditing the diff (e.g., v1.2.3...<commit>) for breaking changes, regressions, improvement opportunities, and risks before releasing openai-agents-js.
examples-auto-run
Run examples:start-all in auto mode with parallel execution, per-script logs, and start/stop helpers.
implementation-strategy
Decide how to implement runtime and API changes in openai-agents-js before editing code. Use when a task changes exported APIs, runtime behavior, schemas, tests, or docs and you need to choose the compatibility boundary, whether shims or migrations are warranted, and when unreleased interfaces can be rewritten directly.
docs-sync
Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Only update English docs (docs/src/content/docs/**) and never touch translated docs under docs/src/content/docs/ja, ko, or zh. Provide a report and ask for approval before editing docs.
pnpm-upgrade
Keep pnpm current: run pnpm self-update/corepack prepare, align packageManager in package.json, and bump pnpm/action-setup + pinned pnpm versions in .github/workflows to the latest release. Use this when refreshing the pnpm toolchain manually or in automation.
Didn't find tool you were looking for?