github/awesome-copilot/skills/acreadiness-generate-instructions/SKILL.md
acreadiness-generate-instructions
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.
- Source repository stars
- 37,126
- Declared platforms
- 0
- Static risk flags
- 2
- Last source update
- 2026-07-28
- Source checked
- 2026-07-28
Decision brief
What it does—and where it fits
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 pi…
Not for
- Tasks that require unconfirmed production actions or broad system permissions.
- Environments where the pinned source and install steps cannot be inspected.
Compatibility matrix
Platform support, with evidence labels
| Platform | Status | Evidence | What to check |
|---|---|---|---|
| Codex | Not declared | No explicit evidence | Portability before use |
| Claude Code | Not declared | No explicit evidence | Portability before use |
| Cursor | Not declared | No explicit evidence | Portability before use |
| Gemini CLI | Not declared | No explicit evidence | Portability before use |
Installation
Inspect first. Install second.
The source command is displayed only when detected. A safe inspection prompt is always available so your agent can explain every action before execution.
npx skills add https://github.com/github/awesome-copilot --skill "skills/acreadiness-generate-instructions"Inspect the Agent Skill "acreadiness-generate-instructions" from https://github.com/github/awesome-copilot/blob/9933dcad5be5caeb288cebcd370eeeb2fc2f1685/skills/acreadiness-generate-instructions/SKILL.md at commit 9933dcad5be5caeb288cebcd370eeeb2fc2f1685. List every install step, command, network request, credential, file read/write, external action, and rollback step. Explain whether it fits my task. Do not install or execute anything until I approve.
Workflow
What the source asks the agent to do
- 01
Topic vs area .instructions.md files
Both end up in .github/instructions/ but they answer different questions:
Both end up in .github/instructions/ but they answer different questions:You can have both at once: a nested set of topic files plus per-area files for a monorepo. - 02
Frontend area instructions
…AgentRC-generated content for this area… bash npx -y github:microsoft/agentrc instructions --output --strategy [--areas|--area ] [--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,…
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).On confirmation, run the same command without --dry-run (and optionally --force if files already exist).Post-process layout for Copilot output: - 03
Output options
VS Code recognises several instruction file types — AgentRC generates the most common ones:
VS Code recognises several instruction file types — AgentRC generates the most common ones: - 04
Strategies
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 app…
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/.instructions.md, each with an applyTo glob so VS Code only loads the topic when it's relevant. Better for large or multi-…- 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/.instructions.md,… - 05
Per-area files with applyTo
When the user opts into areas, emit one VS Code-native .instructions.md file per area at .github/instructions/.instructions.md. Each file MUST start with frontmatter declaring the glob the rules apply to:
When the user opts into areas, emit one VS Code-native .instructions.md file per area at .github/instructions/.instructions.md. Each file MUST start with frontmatter declaring the glob the rules apply to:markdown --- applyTo: "apps/frontend/" ---
Permission review
Static risk signals and limitations
Runs scripts
The documentation asks the agent to run terminal commands or scripts.
npx -y github:microsoft/agentrc instructions --output <file> --strategy <flat|nested> [--areas|--area <name>] [--claude-md] --dry-runRuns scripts
The documentation asks the agent to run terminal commands or scripts.
**On confirmation, run the same command without `--dry-run`** (and optionally `--force` if files already exist).Writes files
The documentation asks the agent to create, modify, or delete local files.
**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` glWrites files
The documentation asks the agent to create, modify, or delete local files.
Create the `.github/instructions/` directory if missing.Evidence record
Why each signal appears
| Signal | Value | Evidence type | Meaning |
|---|---|---|---|
| Quality score | 80/100 | Computed | Documentation, specificity, maintenance, and trust rules |
| Repository stars | 37,126 | Source | Repository attention, not individual Skill quality |
| Compatibility | 0 platforms | Source | Declared in the catalog source record |
| Usage guide | automated source guide | Editorial | Generated or reviewed according to the visible evidence level |
Pinned source
Provenance and original SKILL.md
- Repository
- github/awesome-copilot
- Skill path
- skills/acreadiness-generate-instructions/SKILL.md
- Commit
- 9933dcad5be5caeb288cebcd370eeeb2fc2f1685
- License
- MIT
- Collected
- 2026-07-28
- Default branch
- main
View the original SKILL.md
/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:
| File | Scope | When to use |
|---|---|---|
.github/copilot-instructions.md | Always-on, whole workspace | Default — VS Code Copilot's native instruction file |
AGENTS.md | Always-on, whole workspace | Multi-agent repos (Copilot + Claude + others) |
.github/instructions/*.instructions.md | Scoped by applyTo glob | Per-area / per-language rules in monorepos |
CLAUDE.md | Claude-specific | Add via --claude-md (nested only) |
Strategies
flat(default) — single.github/copilot-instructions.mdat 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 anapplyToglob 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 readingAGENTS.md). For VS Code Copilot specifically, the native location is.github/instructions/withapplyTofrontmatter — 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:
| Kind | Filename example | applyTo example | Where it comes from |
|---|---|---|---|
| Topic (nested) | testing.instructions.md | **/*.{test,spec}.{ts,tsx,js} | AgentRC --strategy nested topic split |
| Area (monorepo) | frontend.instructions.md | apps/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:
- Read
agentrc.config.jsonto discover declared areas and theirpaths/ globs. Ifpathsis missing, ask the user for the glob (e.g.src/api/**). - Run
agentrc instructions --areas(or--area <name>) to produce the per-area body content. - Wrap each area's content in
.github/instructions/<area>.instructions.mdwith theapplyTofrontmatter taken from the area'spaths. If the user passed--apply-to <glob>on a single-area call, use that glob verbatim. - Leave the main file alone — the root
.github/copilot-instructions.mdstays as the always-on instructions;.instructions.mdfiles 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
- Pick the target file. Default to
.github/copilot-instructions.md. Switch toAGENTS.mdonly if the user mentions multi-agent / Claude / Cursor support. - Always ask which strategy to use —
flatornested— 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.mdfiles (each with anapplyToglob so VS Code only loads them when relevant). Best for large or multi-stack repos. Add--claude-mdto also emitCLAUDE.md. Recommendnestedproactively when the repo has > 5 top-level directories, multiple stacks, or already uses a monorepo tool (turbo/nx/pnpm workspaces).
- Flat (default) — one
- Detect monorepo areas by reading
agentrc.config.json. If areas exist, ask the user whether they want per-area.instructions.mdfiles withapplyToin addition to the root file. Default to "yes" whenagentrc.config.jsondeclares areas. - 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 - Show a short summary of what would change — files that would be created or overwritten, area count + their
applyToglobs, model used (defaultclaude-sonnet-4.6). - On confirmation, run the same command without
--dry-run(and optionally--forceif files already exist). - Post-process layout for Copilot output:
- If
--outputends incopilot-instructions.mdand strategy isnested: move/rewrite AgentRC's.agents/<topic>.mdfiles to.github/instructions/<topic>.instructions.md. Add frontmatter to each file with an appropriateapplyToglob (see "Topic applyTo defaults" below). Delete the now-empty.agents/directory. - If
--areaswas used: also write.github/instructions/<area>.instructions.mdfor every area, using each area'spathsfromagentrc.config.jsonas theapplyToglob (override with--apply-tofor single-area calls). - If
--output AGENTS.mdwas chosen: keep AgentRC's native.agents/layout for nested — agent-agnostic readers expect it there. Create the.github/instructions/directory if missing.
- If
Topic applyTo defaults
When promoting AgentRC's nested topic files to .instructions.md, use these defaults unless the user specifies otherwise:
| Topic | Default 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 | ** |
- Verify by reading the generated file(s) back and showing the user a 1-paragraph synopsis: stack detected, conventions captured, length, list of
.instructions.mdfiles with their globs. - Suggest next steps:
- Re-run the
assessskill to confirm the AI Tooling pillar score improved. - If the user already has both
copilot-instructions.mdandAGENTS.md, recommend consolidating to a single source of truth (AgentRC flags this at maturity Level 2+).
- Re-run the
Notes
- AgentRC reads your actual code — no templates. Output reflects detected languages, frameworks, and conventions.
--claude-md(nested strategy only) also emitsCLAUDE.md.- VS Code applies
.instructions.mdfiles automatically when the active file matchesapplyTo. The root.github/copilot-instructions.mdalways loads. - Never run this skill non-interactively in CI; instructions are part of the repo and should land via PR.
Alternatives
Compare before choosing
coreyhaines31/marketingskills
ab-testing
When the user wants to plan, design, or implement an A/B test or experiment, or build a growth experimentation program. Also use when the user mentions "A/B test," "split test," "experiment," "test this change," "variant copy," "multivariate test," "hypothesis," "should I test this," "which version is better," "test two versions," "statistical significance," "how long should I run this test," "growth experiments," "experiment velocity," "experiment backlog," "ICE score," "experimentation program
event4u-app/agent-config
design-intelligence
Grounded design brief from the adopted corpus — style, WCAG-checked color tokens, typography, layout pattern, anti-patterns. Use on ui-design-brief or any which-style/palette/font/chart decision.
event4u-app/agent-config
existing-ui-audit
Use BEFORE writing or editing any non-trivial UI — inventories components, design tokens, shadcn primitives, and reusable patterns into state.ui_audit. Hard gate for the ui directive set.
event4u-app/agent-config
testing-anti-patterns
Use BEFORE writing/changing tests, adding mocks, or test-only methods on production classes — vs mocking-the-mock, production pollution, partial mocks, and overfit/tautological assertions