Generated banner for Acreadiness Generate Instructions
Generated logo for Acreadiness Generate Instructions

Acreadiness Generate Instructions

GitHubOfficialFirst committed by mvanderbend-msoftDistributed by GitHub

  • Skill
  • Workflow
  • Agent tooling
  • MIT
  • Low risk

From the author

Generate tailored AI agent instruction files via AgentRC instructions command. Produces .github/copilot-instructions.md (default, recommended for Copilot in VS Code) plus optional per-area .instructions.md files with applyTo globs for monorepos. Use after running /acreadiness-assess to close gaps in the AI Tooling pillar.
— the description by mvanderbend-msoft

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill automates the creation and maintenance of AI agent instruction files, serving as the core generation step in the AgentRC workflow. It analyzes your codebase to produce context-aware instructions, supporting both simple flat configurations and advanced nested structures for monorepos. By generating VS Code-native .instructions.md files with specific applyTo globs, it ensures that AI assistants receive relevant, scoped guidance based on the file currently being edited.

What it does

  • Generates .github/copilot-instructions.md for workspace-wide AI guidance.
  • Creates scoped .instructions.md files for specific monorepo areas or topics.
  • Applies path-based globs to ensure instructions load only when relevant.
  • Supports nested strategies to organize complex instruction sets.
  • Integrates with agentrc.config.json to detect project-specific areas and conventions.
  • Provides a dry-run mode to preview changes before applying them to the repository.

When to use it

  • After running an assessment to address gaps in AI tooling.
  • When setting up a new project or onboarding a new AI coding assistant.
  • When project structure changes, requiring updated instructions for the AI.
  • When managing large monorepos that require different rules for different directories.
  • When you need to consolidate or refresh existing AI instruction files.

Advantages

  • Ensures AI instructions are derived from actual code rather than generic templates.
  • Reduces AI noise by scoping instructions to relevant file types and directories.
  • Maintains a consistent, professional structure for AI-assisted development.
  • Simplifies the management of multi-agent configurations in complex repositories.

Usage examples

“Generate default AI instructions for this repository.”
The agent performs a dry-run, suggests a flat strategy, and creates a .github/copilot-instructions.md file based on the detected project stack.
“Create nested instructions for my monorepo.”
The agent analyzes the monorepo areas, generates a hub file, and creates specific .instructions.md files for each area with appropriate applyTo globs.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/github/acreadiness-generate-instructions/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip acreadiness-generate-instructions.zip -d .agents/skills

Documentation by mvanderbend-msoft

/acreadiness-generate-instructions — write AI agent instructions

Use this skill whenever the user wants to create, regenerate, or refresh their custom instructions for AI coding agents (Copilot, Claude, etc.). This is the Generate step in AgentRC's Measure → Generate → Maintain loop and the single highest-leverage action for the AI Tooling pillar.

Output options

VS Code recognises several instruction file types — AgentRC generates the most common ones:

FileScopeWhen to use
.github/copilot-instructions.mdAlways-on, whole workspaceDefault — VS Code Copilot's native instruction file
AGENTS.mdAlways-on, whole workspaceMulti-agent repos (Copilot + Claude + others)
.github/instructions/*.instructions.mdScoped by applyTo globPer-area / per-language rules in monorepos
CLAUDE.mdClaude-specificAdd via --claude-md (nested only)

Strategies

  • flat (default) — single .github/copilot-instructions.md at the chosen path. Simple, easy to review.

  • nested — hub at .github/copilot-instructions.md + per-topic detail files at .github/instructions/<topic>.instructions.md, each with an applyTo glob so VS Code only loads the topic when it's relevant. Better for large or multi-stack repos.

Why .github/instructions/ and not .agents/? AgentRC's default nested layout writes to .agents/, which is the right home for agent-agnostic repos (Copilot + Claude + Cursor reading AGENTS.md). For VS Code Copilot specifically, the native location is .github/instructions/ with applyTo frontmatter — that's what Copilot auto-discovers. This skill rewrites AgentRC's nested output to the VS Code-native location whenever the main output is .github/copilot-instructions.md. If you instead chose --output AGENTS.md, nested keeps AgentRC's default .agents/ layout.

For monorepos, generate area-scoped instructions with --areas, --area <name>, or --areas-only. Areas are defined in agentrc.config.json. Per-area output is written as VS Code .instructions.md files with an applyTo glob (see below).

Topic vs area .instructions.md files

Both end up in .github/instructions/ but they answer different questions:

KindFilename exampleapplyTo exampleWhere it comes from
Topic (nested)testing.instructions.md**/*.{test,spec}.{ts,tsx,js}AgentRC --strategy nested topic split
Area (monorepo)frontend.instructions.mdapps/frontend/**agentrc.config.json areas + --areas

You can have both at once: a nested set of topic files plus per-area files for a monorepo.

Per-area files with applyTo

When the user opts into areas, emit one VS Code-native .instructions.md file per area at .github/instructions/<area>.instructions.md. Each file MUST start with frontmatter declaring the glob the rules apply to:

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

# Frontend area instructions

…AgentRC-generated content for this area…

Workflow:

  1. Read agentrc.config.json to discover declared areas and their paths / globs. If paths is missing, ask the user for the glob (e.g. src/api/**).

  2. Run agentrc instructions --areas (or --area <name>) to produce the per-area body content.

  3. Wrap each area's content in .github/instructions/<area>.instructions.md with the applyTo frontmatter taken from the area's paths. If the user passed --apply-to <glob> on a single-area call, use that glob verbatim.

  4. Leave the main file alone — the root .github/copilot-instructions.md stays as the always-on instructions; .instructions.md files only kick in for matching paths.

Naming: lowercase, kebab-case area name. Examples: .github/instructions/frontend.instructions.md, .github/instructions/api.instructions.md, .github/instructions/infra.instructions.md.

Steps

  1. Pick the target file. Default to .github/copilot-instructions.md. Switch to AGENTS.md only if the user mentions multi-agent / Claude / Cursor support.

  2. Always ask which strategy to use — flat or nested — unless the user already specified one in their message or via --strategy. Present the trade-off briefly:

    • Flat (default) — one .github/copilot-instructions.md. Simple, easy to review in a single PR. Best for small/medium repos with one stack.

    • Nested — hub .github/copilot-instructions.md + per-topic .github/instructions/<topic>.instructions.md files (each with an applyTo glob so VS Code only loads them when relevant). Best for large or multi-stack repos. Add --claude-md to also emit CLAUDE.md. Recommend nested proactively when the repo has > 5 top-level directories, multiple stacks, or already uses a monorepo tool (turbo/nx/pnpm workspaces).

  3. Detect monorepo areas by reading agentrc.config.json. If areas exist, ask the user whether they want per-area .instructions.md files with applyTo in addition to the root file. Default to "yes" when agentrc.config.json declares areas.

  4. Run dry-run first so the user can preview:

    npx -y github:microsoft/agentrc instructions --output <file> --strategy <flat|nested> [--areas|--area <name>] [--claude-md] --dry-run
  5. Show a short summary of what would change — files that would be created or overwritten, area count + their applyTo globs, model used (default claude-sonnet-4.6).

  6. On confirmation, run the same command without --dry-run (and optionally --force if files already exist).

  7. Post-process layout for Copilot output:

    • If --output ends in copilot-instructions.md and strategy is nested: move/rewrite AgentRC's .agents/<topic>.md files to .github/instructions/<topic>.instructions.md. Add frontmatter to each file with an appropriate applyTo glob (see "Topic applyTo defaults" below). Delete the now-empty .agents/ directory.

    • If --areas was used: also write .github/instructions/<area>.instructions.md for every area, using each area's paths from agentrc.config.json as the applyTo glob (override with --apply-to for single-area calls).

    • If --output AGENTS.md was chosen: keep AgentRC's native .agents/ layout for nested — agent-agnostic readers expect it there. Create the .github/instructions/ directory if missing.

Topic applyTo defaults

When promoting AgentRC's nested topic files to .instructions.md, use these defaults unless the user specifies otherwise:

TopicDefault 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**
anything else / hub-level**
8. Verify by reading the generated file(s) back and showing the user a 1-paragraph synopsis: stack detected, conventions captured, length, list of .instructions.md files with their globs.
9. Suggest next steps:
  • Re-run the assess skill to confirm the AI Tooling pillar score improved.

  • If the user already has both copilot-instructions.md and AGENTS.md, recommend consolidating to a single source of truth (AgentRC flags this at maturity Level 2+).

Notes

  • AgentRC reads your actual code — no templates. Output reflects detected languages, frameworks, and conventions.

  • --claude-md (nested strategy only) also emits CLAUDE.md.

  • VS Code applies .instructions.md files automatically when the active file matches applyTo. The root .github/copilot-instructions.md always loads.

  • Never run this skill non-interactively in CI; instructions are part of the repo and should land via PR.

Files

Requirements and compatibility

Written for: GitHub Copilot, Claude Code

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Claude Code frontmatter, Names Copilot tools, Needs Node.js

Security

What our scanner noticed· Low risk

  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

First committed by
GitHub avatar of mvanderbend-msoftmvanderbend-msoft
Publisher
GitHub (Official)
Distributed by
GitHub
Source
github/awesome-copilot · skills/acreadiness-generate-instructions · commit 797337f
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Contributors
mvanderbend-msoft

AutoGineer is not affiliated with or endorsed by mvanderbend-msoft or GitHub.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download acreadiness-generate-instructions.zip