review-code について
review-code は、正確性、可読性、性能、セキュリティ、テスト、アーキテクチャの 6 観点からコードを調べるレビュー用 Skill です。深刻度別の報告書と修正案を生成し、構造化されたレビューを行うチームに適しています。
主な機能
- 016 つのコードレビュー観点
- 02簡易スキャン後に詳細レビュー
- 03深刻度別の問題分類
- 04位置と修正案を含む報告
- 05状態に応じたレビューアクション選択
活用シーン
- 01マージ前のコード変更確認
- 02セキュリティと性能の問題特定
- 03テスト網羅性と設計整合性の評価
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ catlog22/ claude-code-workflow --skill review-codeインストール後、Claude Code で/review-codeを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
phases/orchestrator.mdstate-manager.mdstate-schema.mdphases/actions/action-collect-context.mdaction-complete.mdaction-deep-review.mdaction-generate-report.mdaction-quick-scan.mdspecs/issue-classification.mdquality-standards.mdreview-dimensions.mdspecs/rules/architecture-rules.jsoncorrectness-rules.jsonindex.mdperformance-rules.jsonreadability-rules.jsonsecurity-rules.jsontesting-rules.jsontemplates/issue-template.mdreview-report.md詳細
コードレビュー
コードを6つの主要な観点から分析し、実行可能な推奨事項を含む構造化されたレビュー報告書を作成する、多角的なコードレビュースキルです。
アーキテクチャの概要
┌─────────────────────────────────────────────────────────────────┐
│ ⚠️ Phase 0: Specification Study (强制前置) │
│ → 阅读 specs/review-dimensions.md │
│ → 理解审查维度和问题分类标准 │
└───────────────┬─────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────────┐
│ Orchestrator (状态驱动决策) │
│ → 读取状态 → 选择审查动作 → 执行 → 更新状态 │
└───────────────┬─────────────────────────────────────────────────┘
│
┌───────────┼───────────┬───────────┬───────────┐
↓ ↓ ↓ ↓ ↓
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ Collect │ │ Quick │ │ Deep │ │ Report │ │Complete │
│ Context │ │ Scan │ │ Review │ │ Generate│ │ │
└─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘
↓ ↓ ↓ ↓
┌─────────────────────────────────────────────────────────────────┐
│ Review Dimensions │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │Correctness│ │Readability│ │Performance│ │ Security │ │
│ └──────────┘ └──────────┘ └──────────┘ └──────────┘ │
│ ┌──────────┐ ┌──────────┐ │
│ │ Testing │ │Architecture│ │
│ └──────────┘ └──────────┘ │
└─────────────────────────────────────────────────────────────────┘
プロジェクトのコンテキスト:レビュー基準、チェックリスト、承認ゲートを確認するには、ccw spec load --category reviewを実行してください。
主な設計原則
- 多角的なレビュー:正確性、可読性、パフォーマンス、セキュリティ、テストカバレッジ、アーキテクチャの一貫性という6つの観点を網羅します。
- 段階的な実行:迅速なスキャンで高リスク領域を特定し、詳細なレビューで重要な問題に焦点を当てます。
- 構造化された報告書:重大度別に分類し、ファイルの場所と修正案を提示します。
- 状態駆動型:自律モードでは、レビューの進行状況に応じて次のアクションを動的に選択します。
⚠️ 必須の前提条件(必須)
⛔ 省略禁止:レビュー作業を実行する前に、以下のドキュメントを必ずすべて読んでください。
仕様ドキュメント(必読)
| ドキュメント | 目的 | 優先度 |
|---|---|---|
| specs/review-dimensions.md | レビュー観点の定義とチェックポイント | P0 - 最高 |
| specs/issue-classification.md | 問題の分類と重大度の基準 | P0 - 最高 |
| specs/quality-standards.md | レビュー品質基準 | P1 |
テンプレートファイル(作成前に必読)
| ドキュメント | 目的 |
|---|---|
| templates/review-report.md | レビュー報告書のテンプレート |
| templates/issue-template.md | 問題記録のテンプレート |
実行フロー
┌─────────────────────────────────────────────────────────────────┐
│ Phase 0: Specification Study (强制前置 - 禁止跳过) │
│ → Read: specs/review-dimensions.md │
│ → Read: specs/issue-classification.md │
│ → 理解审查标准和问题分类 │
├─────────────────────────────────────────────────────────────────┤
│ Action: collect-context │
│ → 收集目标文件/目录 │
│ → 识别技术栈和语言 │
│ → Output: state.context (files, language, framework) │
├─────────────────────────────────────────────────────────────────┤
│ Action: quick-scan │
│ → 快速扫描整体结构 │
│ → 识别高风险区域 │
│ → Output: state.risk_areas, state.scan_summary │
├─────────────────────────────────────────────────────────────────┤
│ Action: deep-review (per dimension) │
│ → 逐维度深入审查 │
│ → 记录发现的问题 │
│ → Output: state.findings[] │
├─────────────────────────────────────────────────────────────────┤
│ Action: generate-report │
│ → 汇总所有发现 │
│ → 生成结构化报告 │
│ → Output: review-report.md │
├─────────────────────────────────────────────────────────────────┤
│ Action: complete │
│ → 保存最终状态 │
│ → 输出审查摘要 │
└─────────────────────────────────────────────────────────────────┘
ディレクトリの設定
const timestamp = new Date().toISOString().slice(0,19).replace(/[-:T]/g, '');
const workDir = `.workflow/.scratchpad/review-code-${timestamp}`;
Bash(`mkdir -p "${workDir}"`);
Bash(`mkdir -p "${workDir}/findings"`);
出力構成
.workflow/.scratchpad/review-code-{timestamp}/
├── state.json # 审查状态
├── context.json # 目标上下文
├── findings/ # 问题发现
│ ├── correctness.json
│ ├── readability.json
│ ├── performance.json
│ ├── security.json
│ ├── testing.json
│ └── architecture.json
└── review-report.md # 最终审查报告
レビュー観点
| 観点 | 対象領域 | 主なチェック項目 |
|---|---|---|
| 正確性 | ロジックの正確性 | 境界条件、エラー処理、null チェック |
| 可読性 | コードの可読性 | 命名規則、関数の長さ、コメントの品質 |
| パフォーマンス | パフォーマンス効率 | アルゴリズムの計算量、I/O の最適化、リソースの使用 |
| セキュリティ | セキュリティ | インジェクションのリスク、機密情報、アクセス制御 |
| テスト | テストカバレッジ | テストの十分性、境界値の網羅、保守性 |
| アーキテクチャ | アーキテクチャの一貫性 | デザインパターン、レイヤー構造、依存関係の管理 |
問題の重大度レベル
| レベル | 接頭辞 | 説明 | 必要な対応 |
|---|---|---|---|
| Critical | [C] | ブロッキングとなる問題で、直ちに修正する必要があります | マージ前に必ず修正 |
| High | [H] | 重要な問題で、修正が必要です | 修正を推奨 |
| Medium | [M] | 改善を推奨します | 修正を検討 |
| Low | [L] | 任意の最適化です | 実施できれば望ましい |
| Info | [I] | 情報提供を目的とした提案です | 参考情報 |
参考ドキュメント
| ドキュメント | 目的 |
|---|---|
| phases/orchestrator.md | レビューオーケストレーター |
| phases/state-schema.md | 状態構造の定義 |
| phases/actions/action-collect-context.md | コンテキストの収集 |
| phases/actions/action-quick-scan.md | 迅速なスキャン |
| phases/actions/action-deep-review.md | 詳細なレビュー |
| phases/actions/action-generate-report.md | 報告書の作成 |
| phases/actions/action-complete.md | レビューの完了 |
| specs/review-dimensions.md | レビュー観点の仕様 |
| specs/issue-classification.md | 問題分類の基準 |
| specs/quality-standards.md | 品質基準 |
| templates/review-report.md | 報告書のテンプレート |
| templates/issue-template.md | 問題のテンプレート |
コメント
Markdown 対応