メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.kodus.io/llms.txt

Use this file to discover all available pages before exploring further.

Kody ルールの UI では 2 つの異なるものを設定します。どちらをいつ使うかを理解すると、コードレビューはより効果的になります。 実用的な考え方は次のとおりです。
  • メモリ は、将来のレビューや提案がより的確になるように、Kody にコードベースの仕組みを教えます。
  • レビュールール は、PR がチームの基準に合っていないときに Kody が何を指摘すべきかを定義します。

レビュールール

レビュールールは、コードレビューの専用ステージ中に実行される従来のコードレビューチェックです。ファイルのdiffまたはPR全体を定義した基準と照合して分析します。 最適な用途:
  • アーキテクチャの境界(「ドメイン層はインフラストラクチャをインポートしてはいけません」)
  • コードパターン(「ループ条件で == を使用しないでください」)
  • PRの要件(「すべてのサービスファイルにはテストが必要です」)
  • fileDiffpr_files_diff などの変数を使用した構造的な検証
動作方法:
  • ファイルレベルまたはPRレベルのスコープで適用
  • コードレビュー中のみ実行
  • ファイル参照(@file@repo)とMCP関数をサポート
  • 重要度レベルを持つ提案を生成

メモリ

メモリは、コードレビュー、会話、AI の提案など、すべての操作に挿入される永続的なコンテキスト指示です。Kody がコードベース、規約、好みについて保持しておくべき背景知識を表します。 最適な用途:
  • コードベースの文脈(「このリポジトリはサードパーティ API を反映しているため、一部の外部フィールドは意図的に snake_case のままです」)
  • 提案の好み(「このリポジトリで JS ユーティリティを提案するなら Lodash ではなくネイティブメソッドを優先します」)
  • 移行の文脈(「課金モジュールは移行の途中なので、大きなリファクタではなく段階的な変更を優先します」)
  • アーキテクチャの文脈(「このサービスはヘキサゴナルアーキテクチャを採用し、adapter は境界に置きます」)
動作方法:
  • すべてのプロンプトに高優先度コンテキストとして挿入
  • リポジトリ固有の文脈を与えることで将来の提案を改善
  • 会話(@kody remember: ...)またはUIで手動作成
  • ディレクトリ、リポジトリ、または組織レベルにスコープ設定
  • Kodyがメモリ間の重複排除と競合解決を自動実行

どちらをActive化すべきか

シナリオ使用するもの
すべてのサービスにテストファイルが存在するか確認レビュールール
「このリポジトリは外部 API を反映しているため、一部のレスポンスフィールドは意図的に snake_case のままです」メモリ
PRの説明がテンプレートに従う必要があるレビュールール
「このサービスではテストは中央の test フォルダではなく実装ファイルの近くに置くことが多いです」メモリ
アーキテクチャ層に違反するimportにフラグを立てるレビュールール
「認証モジュールは移行の途中なので、大きなリファクタではなく段階的な変更を優先します」メモリ

変換できますか?

はい。保留中のメモリモーダルで、ファイルパスと重要度レベルを持つより構造化された適用が必要と判断した場合、メモリをレビュールールに変換できます。 詳細については、Kodyルールを参照してください。