> ## 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.

# 一般設定

> レビューの中核設定 — 頻度、PR ワークフロー、スキップ条件、分析タイプ — と kodus-config.yml の完全なリファレンス。

## コア設定

<Note>
  Kodus には 3 つの設定レベルがあります：グローバル、リポジトリ、ディレクトリ。仕組みについては <a href="/ja/how_to_use/code_review/configs/inheritance_overrides">設定の継承とオーバーライド</a> を参照してください。
</Note>

### 設定の優先度

Web UI の代わりに、リポジトリルートの `kodus-config.yml` ファイルでレビュー設定を管理できます。

<Warning>
  **オプトインするまでこのファイルは無視されます。** デフォルトでは
  `kodusConfigFileOverridesWebPreferences` が `false` のため、Kody は `kodus-config.yml` を
  一切読み込みません — ファイルをコミットしただけでは何も起こりません。

  まず **Settings → Code Review → 対象リポジトリ → General** で有効化するか、Web UI から
  リポジトリ（またはディレクトリ）レベルで `kodusConfigFileOverridesWebPreferences: true` を
  設定してください。それではじめてファイルが有効になります。
</Warning>

有効化すると、ファイルは Web 設定の上にマージされます。変更したいキーだけを書けばよく、
省略したものは Web 側の値がそのまま使われます。

<Note>
  **未知のキーは警告なく破棄されます。** 現在のスキーマに含まれないトップレベルのキーは、
  設定が適用される前に削除されます — エラーも警告も出ません。設定が効いていないように
  見える場合は、下のサンプルとスペルを照合してください。
</Note>

<Accordion title="kodus-config.yml のサンプル">
  ```yaml theme={null}
  version: 2.0

  # general
  automatedReviewActive: true
  showStatusFeedback: true
  kodusConfigFileOverridesWebPreferences: false
  reviewCadence:
      type: 'automatic' # automatic | auto_pause | manual
      timeWindow: 15 # 分
      pushesToTrigger: 3
  pullRequestApprovalActive: false
  isRequestChangesActive: false # GitLab では利用できません
  runOnDraft: true
  ignorePaths:
      - 'yarn.lock'
      - 'package-lock.json'
      - 'package.json'
      - '.env'
      - '**/*.json'
  ignoredTitleKeywords: []
  baseBranches: []
  enableCommittableSuggestions: true
  byokModel: '' # 空 = BYOK 設定のモデルを継承

  # Teams / Enterprise のみ。レビュー中にエージェントが参照できる関連リポジトリ。
  # 推奨上限は 3、空 = 機能オフ。
  linkedRepositories: []

  # レビューカテゴリ
  reviewOptions:
      bug: true
      performance: true
      security: true
      business_logic: true

  # 提案コントロール
  suggestionControl:
      applyFiltersToKodyRules: false
      severityLevelFilter: 'medium' # low | medium | high | critical

  # PR サマリー
  summary:
      generatePRSummary: true
      behaviourForNewCommits: 'none'
      behaviourForExistingDescription: 'replace'
      customInstructions: ''

  # kody rules
  ideRulesSyncEnabled: false
  kodyRulesGeneratorEnabled: true
  kodyLearningExcludedReviewers: []
  kodyKnowledgeApproval:
      enabled: false

  # カスタムメッセージ
  customMessages:
      globalSettings:
          hideComments: false # GitHub のみ
          suggestionCopyPrompt: true # Bitbucket では利用できません
      errorReviewMessage:
          status: 'off' # off | active
          content: ''
      startReviewMessage:
          status: 'every_push' # every_push | only_when_opened | off
          content: ''
      endReviewMessage:
          status: 'every_push' # every_push | only_when_opened | off
          content: ''
  ```
</Accordion>

<Note>
  このサンプルは出荷時のデフォルトを反映しています。正典となるのは kodus-ai リポジトリの
  [`default-kodus-config.yml`](https://github.com/kodustech/kodus-ai/blob/main/default-kodus-config.yml)
  です。
</Note>

## レビュー動作

### 自動レビュー

Kody は PR が開かれたときに自動的にレビューするか、`@kody start-review` とコメントしたときのみレビューできます。

<Info>
  これは**初回レビュー**にのみ影響します。以降のコミットについては、下記のレビュー頻度を参照してください。
</Info>

#### レビュー頻度

以降のコミットで Kody がレビューを処理する方法：

<Tabs>
  <Tab title="自動">
    すべての新しいプッシュをレビュー。すべての変更に対して継続的なフィードバック。
  </Tab>

  <Tab title="自動一時停止">
    急速な連続プッシュ中にレビューを一時停止します（例：15 分以内に 3 回のプッシュ）。活発なコーディング中のスパムを防ぎます。

    デフォルト：3 回のプッシュ / 15 分
  </Tab>

  <Tab title="手動">
    `@kody start-review` とコメントした場合のみフォローアップレビューを実行します。
  </Tab>
</Tabs>

### PR ワークフロー

#### PR の自動承認

問題が見つからない場合、Kody は PR を承認します。

**対応プラットフォーム：** GitHub、GitLab、Bitbucket

#### 変更のリクエスト

クリティカルな問題が見つかった場合、Kody は変更をリクエストします。

**対応プラットフォーム：** GitHub、Bitbucket

### スキップ条件

**無視するファイル：** glob パターンを使用します（例：`**/*.js`）、1 行に 1 つ。デフォルト：`yarn.lock`、`package-lock.json`、`package.json`、`.env`、`**/*.json`

**無視するタイトル：** 特定のキーワードを含む PR をスキップします（大文字・小文字を区別しない、最大 100 文字）

**ベースブランチ：** *どの*ターゲットブランチをレビューするかを絞り込みます。

<Info>
  **空（デフォルト）はすべてのターゲットブランチをレビューする意味です** — `dev`/`release`/`master`
  といった組み込みのリストは存在しません。スコープを*狭めたい*ときだけエントリを追加してください。
  リストが空でなくなると、Kody はそれらのブランチ宛の PR だけをレビューします（リポジトリの
  デフォルトブランチは常に含まれます）。

  エントリは PR の**ターゲット**ブランチと照合され、専用の記法をサポートします：

  | エントリ              | 一致するもの                                         |
  | ----------------- | ---------------------------------------------- |
  | `main`            | ちょうど `main` 宛の PR                              |
  | `release/*`       | `release/` 配下の任意のブランチ宛の PR（`*` は 1 階層のワイルドカード） |
  | `=main`           | 完全一致。`main` と書くのと同じ                            |
  | `!staging`        | `staging` 宛の PR を除外                            |
  | `contains:hotfix` | 代わりに**ソース**ブランチと照合 — ヘッドブランチに `hotfix` を含む PR  |

  複数のエントリが一致した場合は、より具体的なものが優先されます。各エントリは 100 文字以内で、
  使用できる文字は `a-z A-Z 0-9 / * - _ ! = :` のみ、`**` は使えません。
</Info>

**ドラフト PR：** `runOnDraft` はデフォルトで `true` なので、ドラフトもレビューされます。
`false` にすると、PR が ready になるまでスキップされます。

## 分析タイプ

Kody は 4 つのカテゴリでレビューします。**Analysis Types** で、または `kodus-config.yml` の
`reviewOptions` で個別に有効・無効を切り替えられます。

* **Bug** — ロジックエラー、競合状態、null 参照、エッジケース、誤った挙動。
* **Security** — 脆弱性、インジェクション、認証の問題、データ露出、シークレット。
* **Performance** — N+1 クエリ、ホットパスでのアロケーション、キャッシュ不足、ブロッキング I/O。
* **Business Logic** — PR に紐づくビジネスルール・要件・受け入れ基準に対して実装を検証します。
  [ビジネスロジック検証](/ja/how_to_use/code_review/business_logic_validation) を参照してください。

<Note>
  Kody Rules はこれらのカテゴリの 1 つ**ではありません** — `reviewOptions` とは無関係に常に実行されます。
  [Kody Rules](/ja/how_to_use/code_review/configs/kody_rules) を参照してください。
</Note>
