code-review-hos

👤 user_62fbd4b9 📦 v1.0.0 ⭐ 4.6 ⬇️ 341 下載
💻 開發程式設計 免費

📖 技能介紹

Code Review Excellence

Transform code reviews from gatekeeping to knowledge sharing through constructive feedback, systematic analysis, and collaborative improvement.

When to Use This Skill

  • Reviewing pull requests and code changes
  • Establishing code review standards for teams
  • Mentoring junior developers through reviews
  • Conducting architecture reviews
  • Creating review checklists and guidelines
  • Improving team collaboration
  • Reducing code review cycle time
  • Maintaining code quality standards

Core Principles

1. The Review Mindset

Goals of Code Review:

  • Catch bugs and edge cases
  • Ensure code maintainability
  • Share knowledge across team
  • Enforce coding standards
  • Improve design and architecture
  • Build team culture

Not the Goals:

  • Show off knowledge
  • Nitpick formatting (use linters)
  • Block progress unnecessarily
  • Rewrite to your preference

2. Effective Feedback

Good Feedback is:

  • Specific and actionable
  • Educational, not judgmental

    7w4.net收錄了海量優質技能外掛。

  • Focused on the code, not the person
  • Balanced (praise good work too)
  • Prioritized (critical vs nice-to-have)
❌ Bad: "This is wrong."
✅ Good: "This could cause a race condition when multiple users
         access simultaneously. Consider using a mutex here."

❌ Bad: "Why didn't you use X pattern?"
✅ Good: "Have you considered the Repository pattern? It would
         make this easier to test. Here's an example: [link]"

❌ Bad: "Rename this variable."
✅ Good: "[nit] Consider `userCount` instead of `uc` for
         clarity. Not blocking if you prefer to keep it."

3. Review Scope

What to Review:

  • Logic correctness and edge cases
  • Security vulnerabilities
  • Performance implications
  • Test coverage and quality
  • Error handling
  • Documentation and comments
  • API design and naming
  • Architectural fit

What Not to Review Manually:

  • Code formatting (use Prettier, Black, etc.)
  • Import organization
  • Linting violations
  • Simple typos

Review Process

Phase 1: Context Gathering (2-3 minutes)

Before diving into code, understand:

  1. Read PR description and linked issue
  2. Check PR size (>400 lines? Ask to split)
  3. Review CI/CD status (tests passing?)
  4. Understand the business requirement
  5. Note any relevant architectural decisions

Phase 2: High-Level Review (5-10 minutes)

  1. Architecture & Design - Does the solution fit the problem?
  2. Performance Assessment - Are there performance concerns?
    • For performance-critical code, consult Performance Review Guide
    • Check: Algorithm complexity, N+1 queries, memory usage
  3. File Organization - Are new files in the right places?
  4. Testing Strategy - Are there tests covering edge cases?

Phase 3: Line-by-Line Review (10-20 minutes)

For each file, check:

  • Logic & Correctness - Edge cases, off-by-one, null checks, race conditions
  • Security - Input validation, injection risks, XSS, sensitive data
  • Performance - N+1 queries, unnecessary loops, memory leaks
  • Maintainability - Clear names, single responsibility, comments

Phase 4: Summary & Decision (2-3 minutes)

  1. Summarize key concerns
  2. Highlight what you liked
  3. Make clear decision:
    • ✅ Approve
    • 💬 Comment (minor suggestions)
    • 🔄 Request Changes (must address)
  4. Offer to pair if complex

Review Techniques

Technique 1: The Checklist Method

Use checklists for consistent reviews. See Security Review Guide for comprehensive security checklist.

Technique 2: The Question Approach

Instead of stating problems, ask questions:

❌ "This will fail if the list is empty."
✅ "What happens if `items` is an empty array?"

❌ "You need error handling here."
✅ "How should this behave if the API call fails?"

Technique 3: Suggest, Don't Command

Use collaborative language:

❌ "You must change this to use async/await"
✅ "Suggestion: async/await might make this more readable. What do you think?"

❌ "Extract this into a function"
✅ "This logic appears in 3 places. Would it make sense to extract it?"

Technique 4: Differentiate Severity

Use labels to indicate priority:

  • 🔴 [blocking] - Must fix before merge
  • 🟡 [important] - Should fix, discuss if disagree
  • 🟢 [nit] - Nice to have, not blocking
  • 💡 [suggestion] - Alternative approach to consider
  • 📚 [learning] - Educational comment, no action needed
  • 🎉 [praise] - Good work, keep it up!

Language-Specific Guides

根據審查的程式碼語言,查閱對應的詳細指南:

Language/Framework Reference File Key Topics
React React Guide Hooks, useEffect, React 19 Actions, RSC, Suspense, TanStack Query v5
Vue 3 Vue Guide Composition API, 響應性系統, Props/Emits, Watchers, Composables
Rust Rust Guide 所有權/借用, Unsafe 審查, 非同步程式碼, 錯誤處理
TypeScript TypeScript Guide 型別安全, async/await, 不可變性
Python Python Guide 可變預設引數, 異常處理, 類屬性
Java Java Guide Java 17/21 新特性, Spring Boot 3, 虛擬執行緒, Stream/Optional
Go Go Guide 錯誤處理, goroutine/channel, context, 介面設計
C C Guide 指標/緩衝區, 記憶體安全, UB, 錯誤處理
C++ C++ Guide RAII, 生命週期, Rule of 0/3/5, 異常安全
CSS/Less/Sass CSS Guide 變數規範, !important, 效能最佳化, 響應式, 相容性
Qt Qt Guide 物件模型, 訊號/槽, 記憶體管理, 執行緒安全, 效能

Additional Resources

🤖 AI 評測

這個 Skill 質量不錯,內容豐富實用,涵蓋多種程式語言的程式碼審查指南和現成模板,團隊拿來就能用。但它更像一本電子手冊,使用者需要自己翻閱查詢內容,缺乏智慧引導,不夠“貼心”。

📊 多維度評分

適應性4
規範性4.6
有效性4.8
可靠性4.7
可信度4.8

📁 包含檔案 (20 個)

📄 SKILL.md 7.3 KB
📄 assets/pr-review-template.md 1.9 KB
📄 assets/review-checklist.md 2.7 KB
📄 reference/architecture-review-guide.md 14.9 KB
📄 reference/c.md 5.5 KB
📄 reference/code-review-best-practices.md 3.7 KB
📄 reference/common-bugs-checklist.md 31.2 KB
📄 reference/cpp.md 7.5 KB
📄 reference/css-less-sass.md 12.8 KB
📄 reference/go.md 19.8 KB
📄 reference/java.md 10 KB
📄 reference/performance-review-guide.md 17.2 KB
📄 reference/python.md 23.8 KB
📄 reference/qt.md 6 KB
📄 reference/react.md 21.5 KB
📄 reference/rust.md 20.5 KB
📄 reference/security-review-guide.md 6.7 KB
📄 reference/typescript.md 12.6 KB
📄 reference/vue.md 20 KB
📄 scripts/pr-analyzer.py 11 KB