AGENT SKILL
release-note-review
Use when the user asks an AI coding agent to turn a git diff into concise release notes with risks, validation evidence, and reviewer-ready wording.
- License 许可
- MIT
- 最近更新
- 2026-05-13
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- release-note-review
- description
- Use when the user asks an AI coding agent to turn a git diff into concise release notes with risks, validation evidence, and reviewer-ready wording.
02 资源文件 1
- 参考文档references/release-note-checklist.md257 B
03 SKILL.md 正文
Release Note Review
Purpose
Create clear release-note drafts from a local diff without hiding risk or inventing user impact.
Use When
Use this skill when the user asks for release notes, changelog text, launch notes, or a reviewer handoff based on local code changes.
Inputs
- The current git diff.
- Existing changelog or release-note style, if present.
- Package manifests or docs that identify the product area.
Workflow
- Inspect the diff and nearby docs before writing.
- Separate user-visible changes from internal refactors.
- Flag migrations, behavior changes, removed APIs, and validation gaps.
- Draft concise release notes in the existing project voice.
- Keep uncertainty explicit when impact cannot be proven from the diff.
Outputs
- A Markdown release-note draft.
- A short risk section.
- Validation evidence and commands that were run.
Validation
Run the repo's relevant test, build, or lint command before finalizing. If no validation command is available, state that clearly.
Safety Boundaries
- Do not claim tests passed unless the command was run.
- Do not invent customer impact that is not visible in the diff.
- Do not publish or submit release notes externally without user approval.
Additional Resources
- Read references/release-note-checklist.md before preparing a public release note.