- Home
- Skills
- Openai
- Openai Agents Python
- Pr Draft Summary
pr-draft-summary_skill
- Python
- Official
18.6k
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill openai/openai-agents-python --skill pr-draft-summary- SKILL.md4.9 KB
Overview
This skill generates a ready-to-paste PR title and draft description when substantive code work is complete. It is triggered for moderate-or-larger changes that touch runtime code, tests, build or docs with behavior impact. The output follows the repository's required PR block and includes a branch suggestion, single-line imperative title, and a descriptive PR body starting with the appropriate lead verb.
How this skill works
The skill runs Git commands to detect the current branch, working tree state, untracked files, staged/unstaged changes, and commits ahead of the base fork point. It classifies the change type (feature, fix, refactor, docs-with-impact), flags potential backward-compatibility risk if runtime code changed, and summarizes the top changed paths with diff statistics. Finally it picks a lead verb, suggests a branch name, and drafts the PR title and description using the repository template.
When to use it
- Wrapping up a moderate-or-larger change that touches runtime, tests, examples, docs with behavior impact, or build/test config.
- You are ready to mark work complete and need a PR-ready summary block to paste into GitHub.
- When commits exist ahead of the base fork point even if the working tree is clean.
- Before opening a PR to ensure an accurate, concise title and description are prepared.
Best practices
- Run the skill after staging and committing your intended changes so summaries reflect final commits.
- Review the inferred change type and backward-compatibility flag; edit details if special cases apply.
- Keep branch names kebab-case and aligned with the suggested pattern (feat/, fix/, docs/).
- Keep the PR title imperative and single-line; expand context in the description only as needed.
- Ensure untracked files you intend to include are added before generating the final PR block.
Example use cases
- Finish a runtime feature under src/agents/ and generate a feature branch suggestion and PR draft.
- Refactor core APIs and flag breaking-change risk while producing an appropriate 'improves' description.
- Update tests and build config, summarizing touched files and producing a concise PR title.
- Change docs that affect behavior and produce a docs-with-impact PR description.
FAQ
The skill summarizes using the commits ahead of the base fork point and still emits the PR block.
How does it choose the lead verb for the PR description?
It infers change type from touched paths: feature→adds, fix→fixes, refactor/perf→improves/updates, docs-only→updates.