mcpField
C
comprehensive-review-pr-enhance

comprehensive-review-pr-enhance

github.com/sickn33テスト・品質48.7k203 回インストール今日更新
リポジトリ

comprehensive-review-pr-enhance について

Git diffをレビュー担当者向けの構造化されたプルリクエスト説明にまとめるスキルです。変更、リスク、テスト情報を整理し、ファイル分類別のチェックリストを作成します。ヒューリスティックな分析は検証済みの結果として扱いません。

主な機能

  1. 01diff範囲の確認
  2. 02変更内容の分類
  3. 03構造化されたPR説明
  4. 04条件に応じたレビュー項目
  5. 05大規模変更の分割提案

活用シーン

  1. 01詳細なPR説明の作成
  2. 02セキュリティ関連変更の明示
  3. 03変更ファイルに応じたレビュー項目の作成
  4. 04大規模PRを分割するかの検討

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill comprehensive-review-pr-enhance

インストール後、Claude Code で/comprehensive-review-pr-enhanceを入力して読み込まれたか確認します。

同梱ファイルresources/implementation-playbook.md

詳細

プルリクエストの改善

使用する場面

  • git diff をレビューしやすいプルリクエストの説明にまとめたい場合。
  • 変更カテゴリ、リスク、テストに関する注記、チェックリストを含む PR の概要が必要な場合。
  • 差分が大きく、短い臨時の概要ではなく、明確な構成がレビュー担当者に必要な場合。

ワークフロー

  1. git diff <base>...HEAD --stat を実行して、変更されたファイルと変更範囲を確認します
  2. 変更を分類します:ソース、テスト、設定、ドキュメント、ビルド、スタイル
  3. 以下のテンプレートを使用して PR の説明を作成します
  4. 変更されたファイルのカテゴリに基づいてレビューチェックリストを追加します
  5. 破壊的変更、セキュリティに関わるファイル、または大きな差分(500 行超)を明示します

PR の説明テンプレート

## Summary


## Changes
| Category | Files | Key change |
|----------|-------|------------|
| source   | `src/auth.ts` | added OAuth2 PKCE flow |
| test     | `tests/auth.test.ts` | covers token refresh edge case |
| config   | `.env.example` | new `OAUTH_CLIENT_ID` var |

## Why


## Testing
- [ ] unit tests pass (`npm test`)
- [ ] manual smoke test on staging
- [ ] no coverage regression

## Risks & Rollback
- **Breaking?** yes / no
- **Rollback**: revert this commit; no migration needed
- **Risk level**: low / medium / high — because ___

レビューチェックリストのルール

差分に該当するファイルカテゴリが含まれる場合にのみ、チェックリストのセクションを追加します:

ファイルカテゴリチェックリスト項目
ソースデバッグ用ステートメントがない、関数が50行未満、説明的な名前、エラー処理
テスト意味のあるアサーション、エッジケース、不安定なテストがない、AAA パターン
設定ハードコードされたシークレットがない、環境変数の説明がある、後方互換性がある
ドキュメント正確である、例が含まれている、変更履歴が更新されている
セキュリティに関わるファイル(パスに auth、crypto、token、password を含む)入力検証、ログにシークレットが含まれていない、認可が正しい

大きな PR の分割

差分が20ファイルまたは1000行を超える場合は、機能領域ごとに分割することを提案します:

git checkout -b feature/part-1
git cherry-pick <commits-for-part-1>

リソース

  • resources/implementation-playbook.md — PR の自動分析、カバレッジレポート、リスクスコアリングのための Python ヘルパー

制限事項

  • このスキルは、タスクが上記の説明の範囲に明確に当てはまる場合にのみ使用してください。
  • 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
  • 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を止めて確認を求めてください。

エビデンスとヘルパーの制限

リポジトリに既存の PR テンプレートがある場合はそれを使用し、実際の差分に合わせて説明の詳細度を調整してください。メトリクス、テスト、パフォーマンス向上、ロールバックの安全性、課題の意図を捏造しないでください。これらの Python スニペットは未完成の概略です。ステータス、カテゴリ、影響、依存関係、カバレッジ、AI の各ヘルパー関数が存在しないため、実装して実行するまでは自動レビュー結果は得られません。ベースとヘッドの SHA を固定し、分離されたチェックアウトで、同じツール/設定およびスコープによる比較可能なカバレッジを比較してください。カバレッジを取得できない場合は不明であり、ゼロではありません。リスクの平均値、行数のしきい値、レビュー所要時間の推定値は恣意的な参考ヒューリスティックであり、個別の重大な指摘や必須レビューに優先することはできません。固定のアーキテクチャ図は説明用であり、推論されたエビデンスではありません。差分行の位置を特定するには Git のハンクとの対応付け、および名前変更・削除・バイナリファイルへの対応が必要です。正規表現の一致やファイル名のカテゴリ分けはセキュリティ分析ではありません。分割したブランチは、すでにすべての変更を含むブランチに順次チェリーピックするのではなく、合意済みのベースから作成してください。説明の草案を作成しても、ブランチのプッシュ、PR の作成、コメント、レビュー、マージが許可されるわけではありません。ユーザーが実際に許可した操作とリポジトリのルールに従ってください。

コメント