> 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 logging と 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" %}

```
リアルタイム処理モジュール内のパフォーマンスが重要な関数は、@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 を追加** 新しいコードコンテキストを追加します。

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

* チームの慣習や例外を説明する明確な記述を書く
* スコープを選択:
  * **すべてのリポジトリ** — 組織全体に適用されます
  * **選択したリポジトリ** — 特定のリポジトリにのみ適用されます

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

{% hint style="info" %}
**効果的なコンテキストを書くためのヒント**

**すること:**

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

**しないこと:**

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

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

どの機能を使うべきかを理解するための簡単なガイドです

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

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

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

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

## フィードバックを使って 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.
