Ctrlk
Changelog NotificationsAPIAikido login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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

Code Context とは？

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

Code Context は、チームの「暗黙知」— つまり、全メンバーが知っているものの従来の lint ルールには反映されていない、文書化されていないルールや例外 — を記録する手段だと考えてください。

Code Context の一般的な例

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

data-export-service リポジトリは、アーカイブデータ用の夜間バッチ処理を行うものです。ここでは意図的にデータベースインデックスを避けています。テーブルは追記専用で、インデックスが一括挿入処理を遅くしてしまうためです。

ツール固有の例外

debug ログや console.log の記述は、troubleshooting-utils リポジトリでは許容されます。これらは本番環境の問題をデバッグするための CLI ツールだからです。

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

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

インポート規約

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

ドキュメント要件

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

パフォーマンス最適化

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

ステップ1。 次へ移動: Code Quality チェック ページで［Code Context］をクリック

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

ステップ 3。 Code Context を定義する

  • チームの慣行や例外を説明する、明確な説明を書いてください

  • スコープを選択してください：

    • すべてのリポジトリ - 組織全体に適用されます

    • 選択したリポジトリ - 特定のリポジトリにのみ適用されます

効果的なコンテキストを書くためのヒント

良い例：

  • 例外がいつ、なぜ適用されるのかを具体的に書く

  • 特定のフォルダ、ファイルパターン、またはリポジトリを参照する

  • アーキテクチャ上の判断の理由を説明する

  • 明確で簡潔な言葉を使う

避けること：

  • 品質チェックの目的を損なう、広すぎる例外を作る

  • チェックのオン/オフで既に対応できることを重複して書かない

  • スコープが明確でない曖昧な記述を書く

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

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

Code Context を使う場面：

  • あなたは 許容される例外 特定の領域におけるベストプラクティスに対して

  • 必要があるのは 既存のルールを調整すること 特定の状況向けに

  • したいのは 説明を提供すること アーキテクチャ上の判断について

カスタムコードルールを使う場面：

  • 必要があるのは 新しい基準を適用する デフォルトのチェックではカバーされない

  • したいのは 特定のパターンを検出する コードベース固有の

  • 必要なのは 厳格な強制 一貫した検出によって

  • したいのは PR をブロックする 特定の違反に対して

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

プルリクエストから直接、追加のコードコンテキストを加えることができます。@AikidoSec にフィードバックや説明をコメントとして投稿するだけで、Aikido がそれを自動的に処理し、今後のレビューの精度向上に役立てます。

最終更新

役に立ちましたか？