> 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 は、チームの「暗黙知」を文書化する方法だと考えてください。つまり、全員が知っているものの、従来の lint ルールには反映されていない暗黙のルールや例外です。
### Code Context の一般的な例
#### パフォーマンスとアーキテクチャの判断
{% code overflow="wrap" %}
```
私たちの data-export-service リポジトリは、アーカイブ済みデータの夜間バッチ処理を行うものです。ここではテーブルが追記専用で、インデックスが一括挿入処理を遅くするため、意図的にデータベースインデックスを避けています。
```
{% endcode %}
#### ツール固有の例外
{% code overflow="wrap" %}
```
デバッグ用の CLI ツールとして設計されているため、production の問題を調査するための troubleshooting-utils リポジトリでは、デバッグログや console.log の記述は許容されています。
```
{% 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 をクリックします
**ステップ2。** クリック **Code Context を追加** 新しいコードコンテキストを追加します。
**ステップ3。** Code Context を定義する
* チームの慣行や例外を説明する、わかりやすい説明を書いてください
* スコープを選択:
* **すべてのリポジトリ** - 組織全体に適用されます
* **選択したリポジトリ** - 特定のリポジトリにのみ適用されます
{% 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=&goal=
```
`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.