Aus dem Quell-Repository gerendert; Überschriften, Beispiele, Code, Tabellen, Links und Bilder bleiben erhalten.
Describe a Pull Request
Create or update the pull request for the current task with a concise description that helps a reviewer understand why the change exists and the shape of the implementation.
Workflow
- Read the description template:
Read({SKILLBASE}/references/pr_description_template.md)
- Identify or create the pull request:
- Check the current branch for a PR with
gh pr view --json url,number,title,state,baseRefName,headRefName 2>/dev/null. - If no PR exists, inspect
git status --short --branchand the commits on the current branch. - Commit task-related changes when needed, push the branch with an upstream, and create a PR for it. Follow the repository's git safety protocol.
- Ask the user to select a PR only when the current branch has no relevant work and there is no safe current-branch PR to create.
- Gather only the context needed to explain the change:
- Read the ticket and any relevant task artifacts.
- Read the complete PR diff and enough surrounding code to understand behavior and ownership.
- Use
gh pr viewto collect PR metadata and changed files. - Read
{SKILLBASE}/references/show-me.mdfor the visual-outline conventions used in the PR body.
- Write the PR description using the template:
- Keep Why the change to exactly one sentence.
- Keep Special things to note to 1-3 bullets. Prioritize reviewer warnings, migrations, compatibility constraints, deliberate omissions, or surprising decisions. Write
- None.when there are no special considerations. - Make Change outline a compact,
/show-me-inspired structural view rather than prose or a file-by-file changelog. - Include only the views that help explain this PR:
- SQL table and endpoint contract changes, plus pseudocode for business logic.
- key data structure / type changes
- A shallow file tree showing changed responsibilities.
- React component tree changes, including important hooks, state, and package boundaries.
- Call-tree, call-stack, control-flow, or data-flow changes.
- Prefer
diffblocks when showing changes to an existing shape. Show the complete target shape when most of it is new or diff notation would obscure ownership or order. - Keep each view focused on what a reviewer needs. Omit categories that did not change.
- optionaL: if you are aware of a ticket id/url, a humanlayer task url, or related plan/document urls, or other relevant links, include them in the header, otherwise omit the header
- Save and publish the description:
- Use
.humanlayer/tasks/{task-slug}/pr-description.mdwhen the task directory exists; otherwise use.humanlayer/tasks/pr-{number}/description.md. - Update the PR with
gh pr edit {number} --body-file {output-path}. - Confirm the update succeeded.
- Report completion:
- Read
{SKILLBASE}/references/describe_pr_final_answer.md. - Respond using that final answer template with the PR URL, saved description URL, and concise list of changed files.
Always read and follow {SKILLBASE}/references/pr_description_template.md. Do not expand the PR body beyond that template.
Write as one human talking to another: avoid jargon and slang, and use simple, coherent, concise language.

