code-review について
Code Reviewは、テスト、プロジェクト内の用語、関連する設計ドキュメントに照らしてコード変更を評価するリポジトリ用スキルです。回帰の根拠を重視し、妥当な設計変更と説明のない逸脱を区別します。
主な機能
- 01変更と回帰のテスト確認
- 02プロジェクト用語の一貫性確認
- 03関連する設計ドキュメントの参照
- 04設計要件との変更内容の照合
- 05設計変更の根拠の評価
活用シーン
- 01バグ修正プルリクエストのレビュー
- 02CLIや連携機能の変更確認
- 03アーキテクチャの整合性評価
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ github/ spec-kit --skill code-reviewインストール後、Claude Code で/code-reviewを入力して読み込まれたか確認します。
詳細
コードレビュー
- 各コード変更に、そのコードの動作と防止すべき事象を検証するテストケースが含まれていることを確認します。
- バグ修正のプルリクエストに、変更前にバグが再現し、変更後に修正されていることを示す回帰テストが含まれていることを確認します。レビュアーが比較を実行できない場合は、入手可能な根拠を使い、その制約を明記します。
- 文言の変更に、リポジトリ内で一貫して使用されている用語が使われていることを確認します。この確認では、コミュニティが作成したカタログコンテンツと、その生成ドキュメントは対象外とします。
- 影響を受ける領域を特定し、アーキテクチャとの一貫性を評価する前に、
design/内の該当ドキュメントを読みます。CLI コマンドの変更ではdesign/cli.mdを、エージェント連携ではdesign/integration.mdを、ワークフローのステップタイプではdesign/workflow-step.mdを使用します。関連する場合は他の設計ドキュメントも読みますが、すべてのプルリクエストで全ドキュメントを読む必要はありません。 - 実装の境界、所有権、ライフサイクル、提供要件など、該当する設計要件に照らして変更を確認します。このスキル内でルールを重複して記述するのではなく、ドキュメントを参照します。報告する不整合ごとに、該当するドキュメントとセクションを示します。
- 説明のない設計違反と、意図的な設計変更を区別します。意図的な変更については、その根拠と証拠を評価します。設計ドキュメントを更新しただけでは、実装の妥当性を証明できません。
コメント
Markdown 対応