Index of every page on this site: llms.txt
All skills
vercel avatar

/gh-pr-description

@b6b7c56
by vercelvercel/eve6k stars
665
Run it yourself

Drafts and reviews GitHub pull request descriptions for the eve repository. Use when opening, updating, or reviewing a PR, or when summarizing a branch for reviewers.

Use this Skill: https://skilld.dev/gh/vercel/eve/gh-pr-description

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈46 tokens for metadata: the name and description. ≈708 when used: this file.

Description uses 2.3% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈186 characters, or 2.3%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

GitHub PR description

Inspect the branch diff, commits, related issue or discussion, tests, docs, and changesets. When updating a PR, read its current body first.

Write

Fill in the Summary and Changes sections of .github/pull_request_template.md. Never add a Validation, Test plan, or Checklist section, and delete them from an existing body when you update it. Write for a reviewer, not a changelog.

Follow these ASD-STE100 rules where they apply:

  • Use approved words from the ASD-STE100 dictionary, with one meaning per word.
  • Use active voice and keep one topic in each sentence.
  • Limit descriptive sentences to 25 words and procedural sentences to 20 words.
  • Keep necessary technical terms, proper nouns, and code identifiers.

Summary

  • Keep it to one short paragraph: usually 2–4 sentences and about 100 words or fewer.
  • Lead with the concrete problem, user need, or decision behind the change, then state the approach in a sentence or two. Leave the specifics to Changes.
  • Link an existing issue or discussion with Closes #N, Related to #N, or an equivalent when one exists. Do not create an issue solely for a PR.

Changes

A flat list of the changes a reviewer must know, not a narrative.

  • Put public API changes first: new, changed, or removed exports, options, config fields, CLI commands and flags, events, defaults, and error types. Then list other user-visible behavior changes.
  • Write one change per bullet, in one sentence where possible. Name the identifier in code format and its entry point when it has one, such as renderInteractionBlocks() from eve/channels/slack.
  • Add a short reason with "so" or "because" only when the Summary does not already make it clear.
  • Prefix breaking changes with Breaking: and say what callers must change.
  • End with preserved behavior, scope boundaries, or follow-ups only when they matter to review.
  • Usually 2–6 bullets. A one-change PR gets one bullet. Do not nest bullets, add sub-headings, or split the list by commit or original PR.
  • Do not list files, internal refactors, tests, or checks you ran. Include implementation detail only when it is necessary to assess behavior or risk.

Example, from #5733:

### Changes

- Scaffolded projects now default to `@vercel/connect@2.7.0` through
  `DEFAULT_CONNECT_PACKAGE_VERSION`.
- The optional `@vercel/connect` peer is now `^2.7.0`, so npm won't pair eve
  with a connect release that rejects it.
- Templates under `apps/templates` are unchanged. They pin stable eve releases,
  which older connect releases already accept.

Publish

Before publishing, confirm the Summary leads with why the change is needed and Changes lists every public API change. Write the body to a file, then pass it to gh pr create or gh pr edit with --body-file.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill facilitates drafting and reviewing GitHub pull request descriptions. It follows repository-specific guidelines and utilizes the official GitHub CLI to manage PR content. No significant security risks were identified.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: MEDIUM · 1 issue

Signed by skilld at b6b7c56. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated last week
metadata
{
  "internal": true
}

README badge

README badge for vercel/eve/gh-pr-description