概要
Kody は自動またはオンデマンドで PR をレビューし、明確なサジェストを追加し、チームがマージのタイミングを決定するのを助けます。以下は仕組みのシンプルなユーザー向けのビューです。 参考:Figma ボードKody が実行するタイミング
- PR が開かれたとき
- PR に新しいコミットがプッシュされたとき(頻度設定による)
- コメントによる手動トリガー:
@kody start-review
Kody がスキップするタイミング
- 前回の実行以降に新しいコミットがない
- 実際の変更のないマージコミットのみ
- 変更されたすべてのファイルが設定パターンで無視されている
- PR が設定されたファイル制限を超えている
- 無効または欠落した設定
Kody が行うこと
- 適用される設定を解決し(グローバル → リポジトリ → ディレクトリ)、検証します
- この PR の関連する差分とコンテキストを収集します
- PR レベルのチェックを実行します(例:カスタムルールと有効な場合のクロスファイル分析)
- 差分に焦点を当てて変更されたファイルをレビューします
- ノイズを減らすためにサジェストをフィルタリングして優先順位付けします(関連性、重大度、重複排除、セーフガード)
- インラインコメントを投稿し、該当する場合は PR レベルのサマリーも投稿します
- オプションで、それらのポリシーが有効な場合に承認または変更をリクエストします
- フォローアップを増分的に保つために最後に分析したコミットを記憶します
得られるもの
- 具体的なサジェストを含むインラインコメント
- ハイライトを含むオプションの PR レベルサマリー
- オプションのステータス:承認または変更リクエスト(有効の場合)
ステータスリアクション
Kody は絵文字リアクションを使用して、Git プロバイダーでコードレビューのライブステータスを直接表示します。作業中か、完了か、問題が発生したかを推測する必要はありません。常に前の絵文字を最新のステータスに置き換えます(例:🚀 → 🎉、👀、👎、または 😕)。GitHub と GitLab でサポートされています。Azure DevOps と Bitbucket は
まだリアクションをサポートしていません。
各絵文字の意味
- 🚀 処理中 — Kody がコードを処理しています:
- ファイルを分析中
- ルールとポリシーを確認中
- サジェストを生成中
- 🎉 完了 — レビューが終了しました:
- すべてのコメントが投稿済み
- 分析完了
- サジェストを確認できます
- 👀 スキップ — レビューがスキップされました。一般的な理由:
- 前回の実行以降に新しいコミットがない
- マージコミットのみ検出
- PR/MR が設定されたファイル制限を超えている
- レビューする関連ファイルがない(無視パターン)
- レビュー用にブランチが設定されていない
- PR/MR がドラフトモード(ドラフトをスキップするよう設定されている場合)
- 👎 ライセンスなし — ユーザーがライセンスを持っていません:
- Kody は有効なライセンスなしでは実行できません
- PR/MR を開いたユーザーにライセンスが割り当てられていることを確認してください
- オプションで、ライセンスを自動的に割り当てるためにライセンスの自動割り当てを有効にしてください
- 😕 エラー — 何か問題が発生しました:
- レビュー中の一時的な技術的問題
- 再試行してください。問題が続く場合は Discord コミュニティに参加してください
リアクションが表示される場所
- 自動レビュー(PR が開かれたかまたは新しいコミット):PR/MR の説明のリアクション(スレッドの上部)
- 手動レビュー(コメント
@kody start-review):Kody を呼び出したコメントのリアクション
シナリオの例
- 新しい PR(自動):実行中に 🚀 → 完了時に 🎉
- 手動コマンド:コメントに 🚀 → 完了時に 🎉
- 前回の実行以降に変更がない:👀 リアクション
- ライセンスのないユーザー:👎 リアクション
- 一時的な問題:😕 リアクション
FAQ
リアクションが表示されません- GitHub/GitLab:✅ | Azure DevOps/Bitbucket:❌(まだサポートされていません)
- 正常 — Kody は前のステータスを置き換えます(🚀 → 🎉/👀/😕)
- スキップされた可能性があります:新しいコミットがない、マージのみ、無視されたファイル、またはファイル制限
- 修正:
@kody start-reviewとコメントする
- PR/MR を開いたユーザーはライセンスを持っていません
- 修正:ライセンスを割り当てるかライセンスの自動割り当てを有効にする
@kody start-reviewで再試行してください。問題が続く場合はトラブルシューティングまたは Discord を確認してください
重要な設定
- 自動と手動のレビューとフォローアップの頻度
- スコープ内の無視パターンとベースブランチ
- カスタムルールとクロスファイル分析
- サジェスト制御:重大度フィルター、グループ化、最大サジェスト
- ファイル制限とタイムアウト
一般設定
モード、頻度、ブランチ、サジェストオプションを設定します
レビューポリシー
サジェストとブロッキングを理解し、それぞれをいつ有効にするかを学びます
トラブルシューティング
一般的な問題を修正し、制限について学びます
ヒント
- PR を小さく保つ — 大きな差分はレビューの品質を低下させます
- PR の説明に仕様/チケットをリンクする
- フィードバックに対処した後、
@kody start-reviewで再実行する