Skip to content

Add write-pr skill for pull request descriptions - #6172

Draft
karunkop wants to merge 1 commit into
cybersemics:mainfrom
karunkop:agent/write-pr-skill
Draft

karunkop wants to merge 1 commit into
cybersemics:mainfrom
karunkop:agent/write-pr-skill

Conversation

@karunkop

Copy link
Copy Markdown
Collaborator

The rules for a pull request description were spread across end-session, create-issue, plan, the Copilot instructions and docs/testing.md, and none of them said what a description should contain. This adds a write-pr skill that does. A description should tell the reviewer only what the diff, the linked issue and CI do not.

  • The shape is the issue reference, a short paragraph with the cause and the change, and bullets stated as behaviour. A section is added only when the reviewer would otherwise ask, such as Decisions, For review, Not changed or Verification.
  • It lists what to cut, with Wait for the drop target's hover in the dragAndDropThought helper #6163 rewritten from about 440 words to about 190 as the worked example. Wait for the drop target's hover in the dragAndDropThought helper #6163's description is now that rewrite.
  • It collects the existing rules in one place: Fixes only for a full fix, bare commit hashes, /tdd <commit>, skip-tdd* as labels, and no em dashes or semicolons.
  • The plan skill's conclusions go in the body and its evidence in a collapsed block at the end, so a description can carry the plan and stay short.
  • AGENTS.md, copilot-instructions.md, worker-bee.agent.md and end-session point to it. docs/agents/skills.md and docs/agents/external-agents.md list it, and .agents/skills/write-pr shares it with local agents.

Verification

An agent described three merged commits (#6070, #6118, #6083) with the skill and without it. With the skill the descriptions came to 219, 194 and 338 words, against 330, 454 and 599 without. Without it, the test-only fix got Steps to Reproduce and a claim that the test "should pass". Both versions kept #5972 open for the partial fix. Two rules were added after that run and have not been re-run: short sentences in the opening paragraph, and a bullet for other callers that a fix in a shared function changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Fd4vvqGUWV42TDr5CEEzGf

The rules for a pull request description were spread across end-session,
create-issue, plan, the Copilot instructions and docs/testing.md, and none
of them said what a description should contain. write-pr gives the shape,
what to cut, and a worked example, and the instructions that cover opening
a pull request now point to it.

Claude-Session: https://claude.ai/code/session_01Fd4vvqGUWV42TDr5CEEzGf
Co-Authored-By: Claude claude-opus-5-5 (xhigh) <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant