Skip to main content
リポジトリルールは IDE ルールファイル検出と同じ自動同期メカニズムを使用します。両方の機能を有効にするには、設定で「リポジトリからルールを自動同期」を有効にしてください。セットアップについては ルールファイル検出 を参照してください。

使い方

リポジトリに直接カスタム Kody ルールを作成するには、特定のディレクトリに構造化されたマークダウンファイルを配置します。これにより、コードと並行してルールをバージョン管理し、チーム全体で共有できます。

同期

  • 自動検出:リポジトリルールは有効化されると自動的に検出および同期されます
  • 手動同期:任意のルールファイルに @kody-sync を追加して個別に同期します(自動同期が無効でも機能します)
  • Webアプリケーション:同期されたルールは Kodus Web アプリケーションのダッシュボードに表示されます
  • リアルタイム更新:プルリクエストがクローズされるとルールファイルの変更が同期されます

ファイルの場所

ルールファイルを以下のいずれかのディレクトリに配置してください:
  • .kody/rules/**/*.md
  • rules/**/*.md

ルールテンプレート

各ルールファイルはこの正確なテンプレート構造に従う必要があります:

テンプレートフィールド

必須フィールド

ルールの例

ファイルレベルルールの例

プルリクエストレベルルールの例

セットアップ要件

リポジトリルールを使用するには、2 つのオプションがあります:

オプション 1:自動同期を有効にする(推奨)

  1. ルールファイル検出を有効にする:設定で「リポジトリからルールを自動同期」をトグルします
  2. ルールファイルを作成する.kody/rules/** または rules/** ディレクトリに .md ファイルを配置します
  3. 自動同期:PR がクローズされるとすべてのルールファイルが同期されます

オプション 2:手動同期(選択的)

  1. ルールファイルを作成する.kody/rules/** または rules/** ディレクトリに .md ファイルを配置します
  2. 同期マーカーを追加する:ルールファイルの任意の場所に @kody-sync を含めます
  3. 変更をコミット:マークされたファイルのみが同期されます(自動同期のトグルはオフのまま)
リポジトリルールはルールファイル検出と同じ同期メカニズムを使用します。手動同期(@kody-sync)を使用すると、自動同期を有効にせずに特定のルールを選択的に同期できます。