技能 编程开发 撰写协作式代码审查评论

撰写协作式代码审查评论

v20260906
comment-writer
本技能提供了一套专业的协作式评论写作指南,适用于GitHub PR反馈、Issue讨论或Slack沟通。它指导用户如何以“温和但直接”的语气,结构化地给出反馈,确保评论简洁、有重点,并包含明确的后续行动步骤,提升团队沟通效率。
获取技能
310 次下载
概览

When to Use

Load this skill whenever you write a comment that another human will read.

Use it for:

  • GitHub PR or issue comments.
  • Review feedback and requested changes.
  • Maintainer replies.
  • Slack, Discord, or async project updates.

Voice Rules

Rule Requirement
Be useful fast Start with the actionable point. Do not recap the whole PR before feedback.
Be warm and direct Sound like a thoughtful teammate, not a corporate bot.
Keep it short Prefer 1 to 3 short paragraphs or a tight bullet list.
Explain why Give the technical reason when asking for a change.
Avoid pile-ons Comment on the highest-value issue, not every tiny preference.
Match target context language Write in the target context language by default: Spanish issue/thread -> Spanish comment, English issue/thread -> English comment, mixed context -> target message language. If the user explicitly requests a language or tone, follow that request. For Spanish comments, use neutral/professional Spanish by default unless the user or target context clearly calls for regional tone.
No em dashes Use commas, periods, or parentheses instead.

Comment Formula

<Direct observation or request>

<Why it matters, only if needed>

<Concrete next action>

Examples

Request change

Good approach overall. I'd split this into a separate commit because it mixes validation logic with UI wiring.

That keeps the reviewer's focus narrower and makes rollback cleaner if the integration fails.

Approve with a note

Approved. The scope is clear and the change is well-contained.

For the next PR, add links to the previous and following PRs so the chain stays navigable.

Ask for split

This PR exceeds the 400-line budget, so we need to split it or justify `size:exception`.

Suggested order: foundation + tests first, then integration, then docs. That gives each review a clear start and end.

Commands

# Inspect a PR before writing review feedback
gh pr view <PR_NUMBER> --json title,body,additions,deletions,changedFiles
信息
Category 编程开发
Name comment-writer
版本 v20260906
大小 2.35KB
更新时间 2026-09-07
语言