Agent Skillsgrafana/ai-sdk › pr-description-writer

pr-description-writer

GitHub

根据代码差异、提交记录或相关上下文,生成或重写符合规范的 Pull Request 描述。帮助审查者理解具体的行为变更、原因及验证情况,提升代码审查效率。

.agents/skills/pr-description-writer/SKILL.md grafana/ai-sdk

Trigger Scenarios

需要为 Pull Request 撰写描述 需要优化或重写现有的 PR 说明

Install

npx skills add grafana/ai-sdk --skill pr-description-writer -g -y
More Options

Non-standard path

npx skills add https://github.com/grafana/ai-sdk/tree/main/.agents/skills/pr-description-writer -g -y

Use without installing

npx skills use grafana/ai-sdk@pr-description-writer

指定 Agent (Claude Code)

npx skills add grafana/ai-sdk --skill pr-description-writer -a claude-code -g -y

安装 repo 全部 skill

npx skills add grafana/ai-sdk --all -g -y

预览 repo 内 skill

npx skills add grafana/ai-sdk --list

SKILL.md

Frontmatter
{
    "name": "pr-description-writer",
    "description": "Write or rewrite pull request descriptions from a branch diff, commit range, existing PR, issue, upstream reference, specification, bug report, or review context. Use when an agent needs to create, update, or improve a PR body so it explains concrete code and behavior changes, why they were made, validation performed, and remaining risk."
}

PR Description Writer

Use this skill to produce PR descriptions that help reviewers understand what changed and why. The description must explain concrete behavior and code changes, not just list touched files, dependencies, generated artifacts, or snapshot churn.

Workflow

  1. Inspect the available context:
    • current diff, branch range, or PR diff
    • commit list and commit messages
    • existing PR body, issue, bug report, spec, design doc, or upstream source
    • validation commands and residual risks
  2. Group changes by reviewer-relevant behavior or subsystem. Prefer categories such as API behavior, provider conversion, stream/wire format, UI behavior, persistence, docs/examples, tests/fixtures, or tooling.
  3. For each group, explain:
    • what changed in code or behavior
    • why the change was needed
    • what evidence or reference supports it
  4. Reference upstream/source context when it materially explains the change: upstream implementation, tests, release notes, specs, issues, review comments, or conformance fixtures. Mention references next to the relevant change, not only in a generic footer.
  5. Separate generated or mechanical updates from semantic changes. Generated snapshots, lockfiles, schema output, or formatter churn should support the behavioral explanation, not replace it.
  6. Include validation commands actually run. Do not imply checks passed if they did not run.
  7. Include residual risk, accepted deviations, skipped tests, or follow-up work when relevant.
  8. Keep the result concise enough for reviewers to scan. Prefer precise bullets over broad prose.

Structure

Use this structure by default and omit sections that do not apply:

## Summary

- One to four bullets describing the outcome in reviewer-facing terms.
- Include the main code/behavior changes, not only version or dependency bumps.

## Code Changes

- Area: concrete change, reason, and reference when useful.
- Area: concrete change, reason, and reference when useful.

## Tests And Fixtures

- What tests, fixtures, snapshots, or generated artifacts changed and what they
  prove.

## Validation

- `command`
- `command`

## Residual Risk

- Accepted gaps, intentional deviations, skipped fixtures/tests, blockers, or
  follow-ups.

For small PRs, merge Code Changes and Tests And Fixtures into Summary. For release, parity, migration, or generated-heavy PRs, keep the sections separate so reviewers can distinguish behavior from generated output.

Quality Bar

  • Avoid vague bullets like "updates provider code" or "regenerates snapshots" unless followed by the behavior that changed.
  • Avoid file-by-file summaries unless each file maps cleanly to a reviewer concern.
  • Do not describe unrelated opportunities discovered during review as PR scope.
  • Do not overstate certainty. Use "documents residual risk" or "leaves follow-up" when behavior remains intentionally incomplete.
  • Preserve conventional PR titles and repository-specific PR norms.

Version History

  • 1ed365c Current 2026-08-02 21:49

Same Skill Collection

.agents/skills/ai-sdk-parity-review/SKILL.md
.agents/skills/ai-sdk-parity-upgrade/SKILL.md
.agents/skills/openspec-apply-change/SKILL.md
.agents/skills/openspec-archive-change/SKILL.md
.agents/skills/openspec-explore/SKILL.md
.agents/skills/openspec-propose/SKILL.md
.agents/skills/openspec-sync-specs/SKILL.md
.agents/skills/openspec-verify-change/SKILL.md

Metadata

Files
0
Version
1ed365c
Hash
3424032c
Indexed
2026-08-02 21:49

trang chủ - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-03 12:39
浙ICP备14020137号-1 $bản đồ khách truy cập$