Back to Skills

comprehensive-review

majiayu000
Updated Yesterday
58
9
58
View on GitHub
Metageneral

About

This skill performs a mandatory 7-criteria code review after feature implementation, requiring findings to be documented and posted to a GitHub issue. It enforces completion by blocking PR creation until all issues are addressed or deferred with tracking tickets. Use it as a final self-review gatekeeper before submitting work for team review.

Quick Install

Claude Code

Recommended
Plugin CommandRecommended
/plugin add https://github.com/majiayu000/claude-skill-registry
Git CloneAlternative
git clone https://github.com/majiayu000/claude-skill-registry.git ~/.claude/skills/comprehensive-review

Copy and paste this command in Claude Code to install this skill

Documentation

Comprehensive Review

Overview

Review code against 7 criteria before considering it complete.

Core principle: Self-review catches issues before they reach others.

HARD REQUIREMENT: Review artifact MUST be posted to the GitHub issue. This is enforced by hooks.

Announce at start: "I'm performing a comprehensive code review."

Review Artifact Requirement

This is not optional. Before a PR can be created:

  1. Complete review against all 7 criteria
  2. Document all findings
  3. Post artifact to issue comment using EXACT format below
  4. Address all findings (fix or defer with tracking issues)
  5. Update artifact to show "Unaddressed: 0"

The review-gate skill and PreToolUse hook will BLOCK PR creation without this artifact.

The 7 Criteria

1. Blindspots

Question: What am I missing?

CheckAsk Yourself
Edge casesWhat happens at boundaries? Empty input? Max values?
Error pathsWhat if external services fail? Network issues?
ConcurrencyMultiple users/threads? Race conditions?
StateWhat if called in wrong order? Invalid state?
DependenciesWhat if dependency behavior changes?
// Blindspot example: What if items is empty?
function calculateAverage(items: number[]): number {
  return items.reduce((a, b) => a + b, 0) / items.length;
  // Blindspot: Division by zero when items is empty!
}

// Fixed
function calculateAverage(items: number[]): number {
  if (items.length === 0) {
    throw new Error('Cannot calculate average of empty array');
  }
  return items.reduce((a, b) => a + b, 0) / items.length;
}

2. Clarity/Consistency

Question: Will someone else understand this?

CheckAsk Yourself
NamesDo names describe what things do/are?
StructureIs code organized logically?
ComplexityCan this be simplified?
PatternsDoes this match existing patterns?
SurprisesWould anything surprise a reader?

3. Maintainability

Question: Can this be changed safely?

CheckAsk Yourself
CouplingIs this tightly bound to other code?
CohesionDoes this do one thing well?
DuplicationIs logic repeated anywhere?
TestsDo tests cover this adequately?
ExtensibilityCan new features be added easily?

4. Security Risks

Question: Can this be exploited?

CheckAsk Yourself
Input validationIs all input validated and sanitized?
AuthenticationIs access properly controlled?
AuthorizationAre permissions checked?
Data exposureIs sensitive data protected?
InjectionSQL, XSS, command injection possible?
DependenciesAre dependencies secure and updated?

NOTE: If security-sensitive files are changed (auth, api, middleware, etc.), invoke security-review skill for deeper analysis.

5. Performance Implications

Question: Will this scale?

CheckAsk Yourself
AlgorithmsIs complexity appropriate? O(n²) when O(n) possible?
DatabaseN+1 queries? Missing indexes? Full table scans?
MemoryLarge objects in memory? Memory leaks?
NetworkUnnecessary requests? Large payloads?
CachingShould results be cached?

6. Documentation

Question: Is this documented adequately?

CheckAsk Yourself
Public APIsAre all public functions documented?
ParametersAre parameter types and purposes clear?
ReturnsIs return value documented?
ErrorsAre thrown errors documented?
ExamplesAre complex usages demonstrated?
WhyAre non-obvious decisions explained?

See inline-documentation skill for documentation standards.

7. Standards and Style

Question: Does this follow project conventions?

CheckAsk Yourself
NamingFollows project naming conventions?
FormattingMatches project formatting?
PatternsUses established patterns?
TypesFully typed (no any)?
LanguageUses inclusive language?
IPv6-firstNetwork code uses IPv6 by default? IPv4 only for documented legacy?
LintingPasses all linters?

See style-guide-adherence, strict-typing, inclusive-language, ipv6-first skills.

Review Process

Step 1: Prepare

# Get list of changed files
git diff --name-only HEAD~1

# Get full diff
git diff HEAD~1

# Check for security-sensitive files
git diff --name-only HEAD~1 | grep -E '(auth|security|middleware|api|password|token|secret)'
# If matches found, security-review skill is MANDATORY

Step 2: Review Each Criterion

For each of the 7 criteria:

  1. Review all changed code
  2. Note any issues found
  3. Determine severity (Critical/Major/Minor)

Step 3: Check Security-Sensitive

If ANY security-sensitive files were changed:

  1. Invoke security-review skill OR security-reviewer subagent
  2. Include security review results in artifact
  3. Mark "Security-Sensitive: YES" in artifact

Step 4: Document Findings

## Code Review Findings

### 1. Blindspots
- [ ] **Critical**: No handling for empty array in `calculateAverage()`
- [ ] **Minor**: Missing null check in `formatUser()`

### 2. Clarity/Consistency
- [ ] **Major**: Variable `x` should have descriptive name

### 3. Maintainability
- [x] No issues found

### 4. Security Risks
- [ ] **Critical**: SQL injection possible in `findUser()`

### 5. Performance Implications
- [ ] **Major**: N+1 query in `getOrdersWithUsers()`

### 6. Documentation
- [ ] **Minor**: Missing JSDoc on `processOrder()`

### 7. Standards and Style
- [x] Passes all checks

Step 5: Address All Findings

Use apply-all-findings skill to address every issue.

For findings that cannot be fixed:

  1. Use deferred-finding skill to create tracking issue
  2. Link tracking issue in artifact
  3. "Deferred without tracking issue" is NOT PERMITTED

Step 6: Post Artifact to Issue (MANDATORY)

Post review artifact as comment on the GitHub issue:

ISSUE_NUMBER=123
gh issue comment $ISSUE_NUMBER --body "$(cat <<'EOF'
<!-- REVIEW:START -->
## Code Review Complete

| Property | Value |
|----------|-------|
| Worker | `[WORKER_ID]` |
| Issue | #123 |
| Scope | [MINOR|MAJOR] |
| Security-Sensitive | [YES|NO] |
| Reviewed | [ISO_TIMESTAMP] |

### Criteria Results

| # | Criterion | Status | Findings |
|---|-----------|--------|----------|
| 1 | Blindspots | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |
| 2 | Clarity | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |
| 3 | Maintainability | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |
| 4 | Security | [✅ PASS|✅ FIXED|⚠️ DEFERRED|N/A] | [N] |
| 5 | Performance | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |
| 6 | Documentation | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |
| 7 | Style | [✅ PASS|✅ FIXED|⚠️ DEFERRED] | [N] |

### Findings Fixed in This PR

| # | Severity | Finding | Resolution |
|---|----------|---------|------------|
| 1 | [SEVERITY] | [DESCRIPTION] | [HOW_FIXED] |

### Findings Deferred (With Tracking Issues)

| # | Severity | Finding | Tracking Issue | Justification |
|---|----------|---------|----------------|---------------|
| 1 | [SEVERITY] | [DESCRIPTION] | #[ISSUE] | [WHY] |

### Summary

| Category | Count |
|----------|-------|
| Fixed in PR | [N] |
| Deferred (with tracking) | [N] |
| Unaddressed | 0 |

**Review Status:** ✅ COMPLETE
<!-- REVIEW:END -->
EOF
)"

CRITICAL: "Unaddressed" MUST be 0. "Review Status" MUST be "COMPLETE".

Severity Levels

SeverityDescriptionAction
CriticalSecurity issue, data loss, crashMust fix before merge
MajorSignificant bug, performance issueMust fix before merge
MinorStyle, clarity, small improvementShould fix before merge

Checklist

Complete for every code review:

  • Blindspots: Edge cases, errors, concurrency checked
  • Clarity: Names, structure, complexity reviewed
  • Maintainability: Coupling, cohesion, tests evaluated
  • Security: Input, auth, injection, exposure checked (MANDATORY for sensitive files)
  • Performance: Algorithms, queries, memory reviewed
  • Documentation: Public APIs documented
  • Style: Conventions followed
  • All findings documented
  • All findings addressed OR deferred with tracking issues
  • Review artifact posted to issue (exact format)
  • "Unaddressed: 0" in artifact
  • "Review Status: COMPLETE" in artifact

Integration

This skill is called by:

  • issue-driven-development - Step 9

This skill uses:

  • review-scope - Determine review breadth
  • apply-all-findings - Address issues
  • security-review - For security-sensitive changes
  • deferred-finding - For creating tracking issues

This skill is enforced by:

  • review-gate - Verifies artifact before PR
  • PreToolUse hook - Blocks PR without artifact

This skill references:

  • inline-documentation - Documentation standards
  • strict-typing - Type requirements
  • style-guide-adherence - Style requirements
  • inclusive-language - Language requirements
  • ipv6-first - Network code requirements (IPv6 primary, IPv4 legacy)

GitHub Repository

majiayu000/claude-skill-registry
Path: skills/comprehensive-review

Related Skills

algorithmic-art

Meta

This Claude Skill creates original algorithmic art using p5.js with seeded randomness and interactive parameters. It generates .md files for algorithmic philosophies, plus .html and .js files for interactive generative art implementations. Use it when developers need to create flow fields, particle systems, or other computational art while avoiding copyright issues.

View skill

subagent-driven-development

Development

This skill executes implementation plans by dispatching a fresh subagent for each independent task, with code review between tasks. It enables fast iteration while maintaining quality gates through this review process. Use it when working on mostly independent tasks within the same session to ensure continuous progress with built-in quality checks.

View skill

executing-plans

Design

Use the executing-plans skill when you have a complete implementation plan to execute in controlled batches with review checkpoints. It loads and critically reviews the plan, then executes tasks in small batches (default 3 tasks) while reporting progress between each batch for architect review. This ensures systematic implementation with built-in quality control checkpoints.

View skill

cost-optimization

Other

This Claude Skill helps developers optimize cloud costs through resource rightsizing, tagging strategies, and spending analysis. It provides a framework for reducing cloud expenses and implementing cost governance across AWS, Azure, and GCP. Use it when you need to analyze infrastructure costs, right-size resources, or meet budget constraints.

View skill