GitHub PR Description
OfficialFreeStreamline your GitHub pull request descriptions.
Free · Opens the source repo
What GitHub PR Description does
The GitHub PR Description skill is designed to assist developers in drafting and reviewing pull request (PR) descriptions specifically for the eve repository. This skill provides a structured approach to writing PR descriptions, ensuring that all necessary information is communicated clearly and concisely. It guides users through the essential elements to include, such as the problem being solved, the changes made, validation steps, and any points of special attention for reviewers.
By following the outlined process, users can effectively summarize their changes while adhering to best practices. The skill emphasizes the importance of clarity and brevity, encouraging users to keep their summaries under five sentences for most PRs and to provide detailed validation steps. This is particularly useful for teams that prioritize thorough code reviews and need to communicate changes efficiently.
The skill is particularly beneficial for developers who frequently contribute to the eve repository or similar projects on GitHub. It not only helps in crafting well-structured PR descriptions but also serves as a reminder of the key aspects that reviewers should focus on. By using this skill, developers can enhance their communication with reviewers and streamline the review process, ultimately leading to more effective collaboration within their teams.
In summary, the GitHub PR Description skill is a valuable tool for developers looking to improve their pull request documentation practices. It provides clear instructions on what to include in a PR description, helping to ensure that all relevant details are covered without unnecessary verbosity.
When to use it
Use this skill when opening, updating, or reviewing a pull request in the eve repository to ensure clarity and completeness.
When not to use it
This skill may not be suitable for projects that do not follow the same PR conventions or require a different format for PR descriptions.
What you can build with it
Drafting a New Pull Request
When opening a new pull request, use this skill to generate a clear and concise description that highlights the problem and solution.
Updating an Existing PR
If you need to update an existing pull request, this skill helps you revise the description to reflect new changes and validations.
Preparing for Code Review
Before submitting a pull request for review, use this skill to ensure your description answers key questions that reviewers will have.
How to install GitHub PR Description
View source1. Install with the skills CLI
npx skills add vercel/eve/gh-pr-description --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by vercelGitHub PR description
See review notes for the maintainer patterns behind this workflow; they describe what to cover, not how much to write.
Read CONTRIBUTING.md and .github/pull_request_template.md, then inspect the
branch diff, commits, related issue, tests, docs, and changesets. If updating a
PR, read its current body too.
Fill in the repository template. Write for a reviewer:
- explain the concrete problem and solution near the top
- summarize meaningful behavior and decisions, not files or commits
- mention breaking changes, preserved behavior, scope boundaries, or stacked PRs only when relevant
- link the prior issue with
Closes #N,Related to #N, or equivalent - scale length with risk, not diff size
Default to the shortest body that answers the four questions below. Keep the Summary under 5 sentences for most PRs; exceed 10 lines only for breaking or cross-cutting changes. Prefer plain language. Include implementation detail or jargon only when the reviewer cannot assess behavior or risk without it. Do not restate the issue, template guidance, or checklist. Use bullets only when they improve clarity.
A typical small PR body:
### Summary
Closes #412. `eve dev` crashed when an agent had no `connections/` directory;
the compiler now treats missing optional directories as empty.
### Validation
- Reproduced the crash with the weather fixture, then confirmed a clean boot
- `pnpm test:unit`, `pnpm typecheck`
### Checklist
(preserved from the template; only verified items checked)
Under validation, list exact checks actually run and useful manual coverage. State limitations honestly. Do not infer results or claim checks that only CI will run.
Preserve the checklist and check only verified items. If tests, docs, or a changeset are not applicable, say so in one short line at most.
Before returning or publishing the description, confirm that it answers:
- What problem does this solve?
- What meaningfully changes?
- How was it validated?
- What should the reviewer pay special attention to?
Then prune: delete any sentence that restates the diff, the issue, or the template, and any detail the reviewer does not need. If the answer to question 4 is "nothing," leave it out.
When asked only to draft, return the body for review. When asked to create or
update the PR, pass a body file to gh pr create or gh pr edit.
Frequently asked questions about GitHub PR Description
Similar skills
Quality Playbook Generator
Run comprehensive quality audits on any codebase.
PR Draft Summary
Automate PR summary generation for openai-agents-python.
Final Release Review
Streamline your release candidate audits with ease.
Unit Test Vue Pinia
Efficiently write and review unit tests for Vue 3 applications.
Slang Shader Expert
Optimize and integrate Slang shaders with ease.
Telemetry Standards
Ensure consistent event tracking in Supabase Studio.