tomevault-io コードレビュー
コードの品質、セキュリティ、テスト、パフォーマンス、アーキテクチャの観点から包括的なコードレビューを実施します。
レビュー優先順位
🔴 CRITICAL（マージブロック）
- セキュリティ: 脆弱性、シークレットの露出、認証/認可の問題
- 正確性: ロジックエラー、データ破損リスク、競合状態
- 破壊的変更: バージョニングなしの API 契約変更
- データ損失: データ損失・破損のリスク
🟡 IMPORTANT（要議論）
- コード品質: SOLID 原則の重大な違反、過度な重複
- テストカバレッジ: クリティカルパスや新機能のテスト欠落
- パフォーマンス: 明らかなボトルネック（N+1 クエリ、メモリリーク）
- アーキテクチャ: 確立されたパターンからの大幅な逸脱
🟢 SUGGESTION（非ブロッキング）
- 可読性: 命名の問題、簡素化可能な複雑なロジック
- 最適化: 機能に影響しないパフォーマンス改善
- ベストプラクティス: 慣習からの軽微な逸脱
- ドキュメント: 不足・不完全なコメント/ドキュメント
レビューワークフロー
1. コンテキスト確認
レビュー開始前に以下を確認：
- レビュー対象のコード範囲を特定
- プロジェクトの技術スタック・アーキテクチャを把握
- 変更の目的・背景を理解
2. 観点別レビュー
以下の観点で順にチェック：
- セキュリティ: 脆弱性、機密データ、入力検証
- コード品質: 命名、単一責任、DRY、エラーハンドリング
- テスト: カバレッジ、テスト構造、エッジケース
- パフォーマンス: N+1 クエリ、アルゴリズム、リソース管理
- アーキテクチャ: 関心の分離、依存関係、パターン
各観点の詳細なチェック項目と例は references/guide.md を参照。
3. コメント作成
レビューコメントは優先度とカテゴリを明示し、問題の説明・影響・修正案を含める。
コメントのフォーマットと例は references/comment-template.md を参照。
リファレンス
- 詳細ガイド: references/guide.md - 各観点のチェック項目と具体例
- チェックリスト: references/checklist.md - レビュー時の確認項目一覧
- コメントテンプレート: references/comment-template.md - コメントの書き方と例
レビュー原則
- 具体的に: 正確な行、ファイルを参照し、具体的な例を提供
- コンテキストを提供: なぜ問題なのか、潜在的な影響を説明
- 解決策を提案: 間違いだけでなく、修正されたコードを示す
- 建設的に: 作者を批判するのではなく、コードの改善に焦点
- 良い実践を認める: 適切に書かれたコードやスマートな解決策を認める
- 実用的に: すべての提案が即座の実装を必要とするわけではない
- 関連するコメントをグループ化: 同じトピックについて複数のコメントを避ける
Converted and distributed by TomeVault — claim your Tome and manage your conversions.