> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/docs/docs-ja/kdo/add-extra-code-context.md).

# 追加のコードコンテキストを追加

Code Context は、Aikido があなたのチーム独自のコーディング慣行や例外を理解するのに役立ちます。コードベースに関するコンテキストを提供することで、Code Quality がプルリクエストを分析する方法を細かく調整でき、ノイズを減らし、レビューをチームの基準により関連したものにできます。

### Code Context とは何ですか？

Code Context を使うと、チーム固有のコーディング規約、設計上の判断、一般的なベストプラクティスに対する許容可能な例外について Aikido に教えることができます。これにより、Code Quality のコメントは一般論ではなく、関連性があり実行可能なものになります。

Code Context は、チームの「暗黙知」—つまり、チームメンバーなら誰でも知っているけれど、従来のリンティング規則には記録されない、そうした明文化されていないルールや例外—を文書化する方法だと考えてください。

### Code Context のよくある例

#### パフォーマンスとアーキテクチャの判断

{% code overflow="wrap" %}

```
data-export-service リポジトリは、アーカイブ済みデータの夜間バッチ処理を行うためのものです。ここではテーブルが追記専用であり、インデックスが大量挿入処理を遅くしてしまうため、意図的にデータベースインデックスを使っていません。
```

{% endcode %}

#### ツール固有の例外

{% code overflow="wrap" %}

```
debug ログや console.log の記述は、実運用の問題をデバッグするために設計された CLI ツールである troubleshooting-utils リポジトリでは許容されます。
```

{% endcode %}

#### 社内ツール向けの緩和された基準

{% code overflow="wrap" %}

```
migrations/ フォルダ内のデータ移行スクリプトでは、行数制限を何度も超えることがあります。これらは一度きりのスクリプトなので、これは許容されます。また、社内向けスクリプトではチームが使い方を理解しているため、厳格なエラーハンドリングも適用していません。
```

{% endcode %}

#### インポート規約

{% code overflow="wrap" %}

```
@company/ui-components ライブラリからインポートする場合、ワイルドカードインポート（import * as）は許容されます。これは、すべてのコンポーネントを単一の名前空間として意図的にエクスポートしているためです。
```

{% endcode %}

#### ドキュメント要件

{% code overflow="wrap" %}

```
utils/ フォルダ内の内部ヘルパー関数には、緩和された JSDoc 要件が適用されます。完全なドキュメントが必要なのは、エクスポートされる公開 API のみです。
```

{% endcode %}

#### パフォーマンス最適化

{% code overflow="wrap" %}

```
real-time-processing モジュール内のパフォーマンスが重要な関数は、@performance-critical を適切にコメントしていれば、特定の TypeScript の厳格チェックを省略できます。
```

{% endcode %}

### 追加の Code Context を追加する方法

**ステップ 1.** 次へ移動 [Code Quality チェック](https://app.aikido.dev/code-quality/checks) ページを開いて Code Context をクリックします

<figure><img src="/files/86d85cd3b89622917170f52b34328946ea4acd14" alt=""><figcaption></figcaption></figure>

**ステップ 2.** をクリック **Code Context を追加** 新しい code context を追加するには。

**手順 3。** Code Context を定義する

* チームの慣行や例外を説明する明確な説明を書いてください
* 範囲を選択してください:
  * **すべてのリポジトリ** - 組織全体に適用されます
  * **選択したリポジトリ** - 特定のリポジトリにのみ適用されます

<figure><img src="/files/287a8b1983a5624486186a635563e6df2d038e95" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**効果的なコンテキストの書き方のヒント**

**Do:**

* 例外がいつ、なぜ適用されるのかを具体的に書く
* 特定のフォルダ、ファイルパターン、またはリポジトリを参照する
* アーキテクチャ上の判断の背景を説明する
* 明確で簡潔な言葉を使う

**Don’t:**

* 品質チェックの目的を損なうような、広すぎる例外を作成する
* チェックのオン/オフ切り替えですでに対応されている内容を重複させる
* 範囲が明確でない曖昧な記述を書く
  {% endhint %}

### Code Context とカスタムコードルールの違い

どの機能をいつ使うべきかを理解するための簡単なガイドラインを以下に示します

#### 次の場合は Code Context を使います:

* 次のものがあります **許容される例外** 特定の領域におけるベストプラクティスに対する
* あなたが必要としているのは **既存ルールの調整** 特定の状況に対して
* あなたが望むのは **説明を提供すること** アーキテクチャ上の判断について

#### 次の場合はカスタムコードルールを使います:

* あなたが必要としているのは **新しい基準を強制する** デフォルトのチェックではカバーされない
* あなたが望むのは **特定のパターンを検出する** あなたのコードベース固有の
* 必要なのは **厳格な適用** 一貫した検出で
* あなたが望むのは **PR をブロックする** 特定の違反に対して

## フィードバックを使って Code Context を生成する

プルリクエストから直接、追加の code context を追加できます。@AikidoSec にフィードバックや説明をコメントとして投稿するだけで、Aikido がそれを自動的に処理し、今後のレビューの洞察を改善します。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.aikido.dev/docs/docs-ja/kdo/add-extra-code-context.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.