Code Review Guide

👤 mohitagw15856 📦 v1.0.0 ⭐ 4.3 ⬇️ 146 下載
💻 開發程式設計 免費

📖 技能介紹


name: code-review-guide description: "Review a pull request or diff like a thoughtful senior engineer — prioritized, kind, and focused on what matters. Use when reviewing code, giving PR feedback, or asked to 'review this change'. Produces a structured review: a correctness/design pass, comments ranked by severity (blocking → nit), what's done well, and a clear approve / request-changes call — feedback that improves the code and the author." homepage: https://mohitagw15856.github.io/pm-claude-skills/skill/code-review-guide.html metadata: { "openclaw": { "emoji": "🪚" } }


Code Review Guide Skill

Bad code review nitpicks style while missing the design flaw, or dumps 40 ungraded comments. Good review is prioritized and kind: it catches what actually matters (correctness, security, design), separates blocking issues from nits, explains the why, and leaves the author better. This skill runs that review.

Required Inputs

Ask for these only if they aren't already provided:

  • The change — the diff/PR, and ideally its description/intent (what it's trying to do).
  • Context — language/stack, conventions, the part of the system it touches, risk level.
  • Focus (optional) — anything specific to scrutinize (security, performance, a tricky area).

Output Format

小蔥技能有更好的技能skills外掛。

Review: [PR / change]

Summary — in 1–2 lines: what the change does and your overall read (solid / needs work / risky).

Review passes — scan in priority order and note findings: 1. Correctness — does it do what it claims? Edge cases, error handling, off-by-ones, concurrency. 2. Security & data — input validation, authz, secrets, injection, PII handling. 3. Design — is this the right approach? Coupling, the seam, simpler alternative, future pain. 4. Tests — do they cover the behavior and the edges? Would they catch a regression? 5. Readability — names, clarity, dead code, docs where non-obvious.

Comments (ranked by severity) — each with file/line, the issue, why it matters, and a concrete suggestion:

Severity Where Comment & why Suggested change
🔴 Blocking
🟡 Should-fix
🔵 Nit / optional

What's done well — genuinely (specific, not flattery). Reviews are also for morale and learning.

Verdict — ✅ Approve / 🔁 Request changes / 💬 Comment — with the one or two things that gate it.

Quality Checks

  • [ ] Correctness, security, and design are reviewed before style — priority order
  • [ ] Comments are ranked by severity (blocking vs. should-fix vs. nit), not a flat list
  • [ ] Each comment explains why and offers a concrete suggestion, not just "this is wrong"
  • [ ] At least one specific thing done well is noted
  • [ ] A clear verdict (approve / request changes) with the gating issues named
  • [ ] Tone is direct but kind — critiques the code, not the author

Anti-Patterns

  • [ ] Do not nitpick style while missing a correctness or security problem — priority first
  • [ ] Do not dump ungraded comments — rank them so the author knows what's blocking
  • [ ] Do not say "this is wrong" without why and a suggested fix
  • [ ] Do not rewrite it your way for taste — respect working approaches; flag real issues
  • [ ] Do not be a jerk — review the code, acknowledge good work, keep the author motivated

Based On

Senior code-review practice (Google's engineering review guidelines): prioritize correctness/design, severity-tag feedback, be kind.

🤖 AI 評測

這個程式碼審查技能整體質量良好,能幫助生成結構清晰、重點突出的審查意見,對輸入輸出格式的規定比較完善。優點是強調按嚴重性分級評論、提供明確判定結果;不足之處在於缺少實際案例參考,面對複雜程式碼場景時的指導深度有限,實際使用效果可能因具體情況而異。適合作為程式碼審查輔助工具,但不宜完全替代人工審查。

📊 多維度評分

適應性4.3
規範性4
有效性4.7
可靠性4.1
可信度4.4

📁 包含檔案 (3 個)

📄 SKILL.md 3.5 KB
📄 _meta.json 136 B
📄 skill-card.md 2.1 KB