gh-pr-description
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.
- License 许可
- Apache-2.0
- 所属仓库
- vercel/eve
- 最近更新
- 2026-11-15
- Stars
- ★ 5.9k
- Forks
- 656
01 前言 Front Matter
- name
- gh-pr-description
- metadata
- { "internal": true }
- description
- 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.
03 SKILL.md 正文
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()fromeve/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.
04 同仓库更多 Skills
writing-quality
The review rubric: writing-quality rules and reference lists for judging a content draft, covering AI-sounding phrasing, bloated wording, structure, and web-content specs. Load at the start of every review.
writing-quality
Writing-quality guardrails for any prose the agent drafts or edits: blog posts, page copy, Notion drafts, release notes, marketing text. Use this skill whenever writing or revising content meant for humans to read, to keep the prose natural, plain, and free of AI-sounding phrasing. Not needed for code, queries, or structural CMS work.
seo-aeo-best-practices
SEO and AEO best practices for metadata, Open Graph, sitemaps, robots.txt, hreflang, JSON-LD structured data, EEAT, and content optimized for search engines and AI answer surfaces. Use this skill when implementing page SEO, technical SEO, schema markup, international SEO, AI-overview readiness, or improving content for Google, ChatGPT, Perplexity, and similar assistants.
sanity-best-practices
Sanity development best practices for schema design, GROQ queries, TypeGen, Visual Editing, images, Portable Text, Studio structure, localization, migrations, Sanity Functions, Blueprints, and framework integrations such as Next.js, Nuxt, Astro, Remix, SvelteKit, Angular, Hydrogen, and the App SDK. Use this skill whenever working with Sanity schemas, defineType or defineField, GROQ or defineQuery, content modeling, Presentation or preview setups, Sanity-powered frontend integrations, Sanity Functions, documentEventHandler, defineDocumentFunction, defineMediaLibraryAssetFunction, @sanity/functions, @sanity/blueprints, sanity.blueprint.ts, event-driven content automation, or when reviewing and fixing a Sanity codebase.
portable-text-serialization
Render and serialize Portable Text to React, Svelte, Vue, Astro, HTML, Markdown, and plain text. Use when implementing Portable Text rendering in any frontend framework, building custom serializers for non-standard block types, converting Portable Text to HTML strings server-side, converting Portable Text to Markdown, extracting plain text from Portable Text, or troubleshooting rendering issues with marks, blocks, lists, or custom types.
portable-text-conversion
Convert HTML and Markdown content into Portable Text blocks for Sanity. Use when migrating content from legacy CMSs, importing HTML or Markdown into Sanity, building content pipelines that ingest external content, converting rich text between formats, or programmatically creating Portable Text documents. Covers @portabletext/markdown (markdownToPortableText), @portabletext/block-tools (htmlToBlocks), custom deserializers, and the Portable Text specification for manual block construction.