mcpField
A
acreadiness-generate-instructions

acreadiness-generate-instructions

github.com/githubエージェントワークフロー40.5k153 回インストール今日更新
リポジトリ

acreadiness-generate-instructions について

acreadiness-generate-instructionsは、AIコーディングエージェント向けの指示ファイルを作成・更新するAgentRCスキルです。フラット/ネスト型の出力や、monorepo向けのVS Codeネイティブな範囲別指示に対応します。

主な機能

  1. 01コーディングエージェント向け指示の生成・更新
  2. 02フラット型とネスト型の出力戦略
  3. 03VS Codeの範囲別トピック指示
  4. 04monorepoの領域別指示
  5. 05任意のClaude指示ファイル生成

活用シーン

  1. 01Copilot向けのリポジトリ規約の設定
  2. 02大規模コードベースでの指示の分割
  3. 03monorepoの領域ごとのパスルール作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/github/awesome-copilot --skill acreadiness-generate-instructions

インストール後、Claude Code で/acreadiness-generate-instructionsを入力して読み込まれたか確認します。

詳細

/acreadiness-generate-instructions — AI エージェント向けの指示を作成する

ユーザーが AI コーディングエージェント(Copilot、Claude など)向けのカスタム指示を作成、再生成、または更新したい場合は、このスキルを使用してください。これは AgentRC の Measure → Generate → Maintain サイクルにおける Generate のステップであり、AI Tooling の柱において最も効果の高いアクションです。

出力オプション

VS Code はいくつかの種類の指示ファイルを認識します。AgentRC は最も一般的なものを生成します。

ファイル適用範囲使用する場面
.github/copilot-instructions.md常時有効、ワークスペース全体デフォルト — VS Code Copilot のネイティブな指示ファイル
AGENTS.md常時有効、ワークスペース全体複数エージェントを使うリポジトリ(Copilot + Claude + その他)
.github/instructions/*.instructions.mdapplyTo glob で範囲を指定モノレポにおける領域別/言語別のルール
CLAUDE.mdClaude 固有--claude-md で追加(ネストされたファイルのみ)

戦略

  • flat (デフォルト) — 指定したパスに単一の .github/copilot-instructions.md を配置します。シンプルで、レビューも簡単です。
  • nested — .github/copilot-instructions.md にハブを置き、トピックごとの詳細ファイルを .github/instructions/<topic>.instructions.md に配置します。各ファイルには applyTo glob を指定するため、VS Code は該当する場合にのみそのトピックを読み込みます。大規模または複数の技術スタックを持つリポジトリに適しています。

.agents/ ではなく .github/instructions/ を使う理由は? AgentRC のデフォルトのネスト構成では .agents/ に出力します。これは、エージェントに依存しないリポジトリ(Copilot + Claude + Cursor が AGENTS.md を読み込む構成)に適した場所です。VS Code Copilot に限って言えば、ネイティブな場所は applyTo フロントマターを指定した .github/instructions/ であり、Copilot はここを自動検出します。このスキルは、メイン出力が .github/copilot-instructions.md の場合、AgentRC のネスト出力を VS Code ネイティブの場所に書き換えます。代わりに --output AGENTS.md を選択した場合、ネスト出力では AgentRC のデフォルトである .agents/ 構成が維持されます。

モノレポでは、--areas、--area <name>、または --areas-only を使って領域ごとに範囲を限定した指示を生成します。領域は agentrc.config.json で定義します。領域ごとの出力は、applyTo glob を指定した VS Code の .instructions.md ファイルとして書き込まれます(以下を参照)。

トピック別と領域別の .instructions.md ファイル

どちらも .github/instructions/ に配置されますが、それぞれ異なる用途があります。

種類ファイル名の例applyTo の例生成元
トピック(ネスト)testing.instructions.md**/*.{test,spec}.{ts,tsx,js}AgentRC の --strategy nested によるトピック分割
領域(モノレポ)frontend.instructions.mdapps/frontend/**agentrc.config.json の領域 + --areas

両方を同時に使えます。つまり、ネストされたトピックファイル一式と、モノレポ向けの領域別ファイルを併用できます。

applyTo を指定した領域別ファイル

ユーザーが領域を選択した場合は、領域ごとに 1 つの VS Code ネイティブな .instructions.md ファイルを .github/instructions/<area>.instructions.md に出力します。各ファイルの先頭には、ルールの適用対象となる glob を宣言するフロントマターを必ず記述してください。

---
applyTo: "apps/frontend/**"
---

# Frontend area instructions

…AgentRC-generated content for this area…

ワークフロー:

  1. agentrc.config.json を読み込み、定義済みの領域とその paths / glob を確認します。paths がない場合は、ユーザーに glob(例:src/api/**)を尋ねます。
  2. agentrc instructions --areas(または --area <name>)を実行して、領域ごとの本文を生成します。
  3. 各領域の内容を .github/instructions/<area>.instructions.md に配置し、領域の paths から取得した applyTo フロントマターで囲みます。単一領域の呼び出しでユーザーが --apply-to <glob> を指定した場合は、その glob をそのまま使用します。
  4. メインファイルには手を加えません。ルートの .github/copilot-instructions.md は常時有効な指示のままにします。.instructions.md ファイルは、パスが一致する場合にのみ適用されます。

命名規則:領域名は小文字のケバブケースにします。例:.github/instructions/frontend.instructions.md、.github/instructions/api.instructions.md、.github/instructions/infra.instructions.md。

手順

  1. 対象ファイルを選びます。デフォルトは .github/copilot-instructions.md です。 ユーザーがマルチエージェント/Claude/Cursor のサポートに言及した場合に限り、AGENTS.md に切り替えます。
  2. 使用する戦略を必ず確認します。ユーザーがメッセージ内または --strategy で指定していない限り、flat と nested のどちらを使うか尋ねます。トレードオフを簡潔に提示してください。
    • Flat (デフォルト) — .github/copilot-instructions.md を1つ作成します。シンプルで、単一の PR でレビューしやすい方法です。スタックが1つの小規模/中規模リポジトリに最適です。
    • Nested — ハブとなる .github/copilot-instructions.md と、トピックごとの .github/instructions/<topic>.instructions.md ファイルを作成します(各ファイルに applyTo glob を指定することで、VS Code は関連する場合にのみ読み込みます)。大規模リポジトリや複数のスタックがあるリポジトリに最適です。CLAUDE.md も出力するには --claude-md を追加します。 リポジトリにトップレベルのディレクトリが5つを超える場合、複数のスタックがある場合、またはすでにモノレポツール(turbo/nx/pnpm workspaces)を使用している場合は、積極的に nested を推奨してください。
  3. agentrc.config.json を読み取り、モノレポ領域を検出します。領域がある場合は、ルートファイルに加えて、applyTo を指定した領域ごとの .instructions.md ファイルも必要かどうか尋ねます。agentrc.config.json に領域が定義されている場合、デフォルトは「はい」です。
  4. まず dry-run を実行し、ユーザーがプレビューできるようにします。
    npx -y github:microsoft/agentrc instructions --output <file> --strategy <flat|nested> [--areas|--area <name>] [--claude-md] --dry-run
    
  5. 変更内容の概要を簡潔に表示します。作成または上書きされるファイル、領域数とそれぞれの applyTo glob、使用するモデル(デフォルトは claude-sonnet-4.6)を含めます。
  6. 確認を得たら、--dry-run を付けずに同じコマンドを実行します(既存ファイルがある場合は、必要に応じて --force を指定します)。
  7. Copilot 出力のレイアウトを後処理します。
    • --output が copilot-instructions.md で終わり、戦略が nested の場合:AgentRC の .agents/<topic>.md ファイルを .github/instructions/<topic>.instructions.md に移動/書き換えます。「トピックの applyTo のデフォルト」を参照し、各ファイルに適切な applyTo glob を含むフロントマターを追加します。空になった .agents/ ディレクトリを削除します。
    • --areas を使用した場合:各領域の agentrc.config.json 内の paths を applyTo glob として使用し、領域ごとに .github/instructions/<area>.instructions.md も書き込みます(単一領域の呼び出しでは --apply-to で上書きできます)。
    • --output AGENTS.md を選択した場合:nested の場合は AgentRC ネイティブの .agents/ レイアウトを維持します。エージェントに依存しないリーダーはそこにあることを想定しています。 .github/instructions/ ディレクトリがない場合は作成します。
トピックの applyTo のデフォルト

AgentRC の nested トピックファイルを .instructions.md に昇格する場合、ユーザーが別途指定しない限り、次のデフォルトを使用します。

トピックapplyTo のデフォルト
testing**/*.{test,spec}.{ts,tsx,js,jsx,mjs,cjs}
style / code-quality / formatting**/*.{ts,tsx,js,jsx,mjs,cjs,py,go,rs,java,kt,cs}
build / ci**/{package.json,turbo.json,nx.json,.github/workflows/**}
docs**/*.md
security**
その他/ハブレベル**
  1. 生成されたファイルを読み返して検証し、1段落の概要をユーザーに提示します。検出されたスタック、取り込まれた規約、ファイルの長さ、glob とともに .instructions.md ファイルの一覧を含めます。
  2. 次の手順を提案します。
    • assess スキルを再実行し、AI Tooling ピラーのスコアが改善したことを確認します。
    • ユーザーがすでに copilot-instructions.md と AGENTS.md の両方を持っている場合は、情報源を1つに統合することを推奨します(AgentRC は成熟度レベル2以上でこれを指摘します)。

注記

  • AgentRC はテンプレートではなく、実際のコードを読み取ります。出力には、検出された言語、フレームワーク、規約が反映されます。
  • (nested 戦略のみ)--claude-md を指定すると、CLAUDE.md も出力されます。
  • アクティブなファイルが applyTo に一致すると、VS Code は .instructions.md ファイルを自動的に適用します。ルートの .github/copilot-instructions.md は常に読み込まれます。
  • このスキルを CI で非対話形式で実行してはいけません。手順はリポジトリに含まれるため、PR 経由で取り込む必要があります。

コメント