Skip to content
Skillpedia
Documentation40k · #4979

acreadiness-generate-instructions

Helps your agent create instructions for AI tools based on an assessment. It's useful for improving how AI interacts with code and closing identified gaps.

What it does

This tool helps you create or update instruction files for AI coding assistants. It generates files that tell the AI how to behave within your project.

When to use it

  • ✓When you want to set up an AI assistant for the first time.
  • ✓When you need to adjust how the AI interacts with your code.
  • ✓When organizing a large project with many different parts.

Example of what to ask your AI

“Create instructions for Copilot in my project, using the nested strategy and focusing on the frontend and backend areas.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/github/awesome-copilot/blob/main/skills/acreadiness-generate-instructions/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/github/awesome-copilot/blob/main/skills/acreadiness-generate-instructions/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The tool analyzes your project and generates configuration files. It can create one main file or several smaller files for specific parts of your code, depending on how you want to organize.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add github/awesome-copilot --skill acreadiness-generate-instructions

Or download just the file:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/acreadiness-generate-instructions/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

/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.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:

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:

  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.

…

FAQ

What's the difference between 'flat' and 'nested'?

Flat uses a single instruction file for the whole project. Nested uses a main file plus smaller files for specific topics or areas, which is better for large projects.

What is 'applyTo'?

'applyTo' is a setting that tells the AI to use specific instructions only in certain parts of your code, like the 'frontend' folder or test files.

Do I need an 'agentrc.config.json' file?

It's not required, but if you have one, the tool can use the information in it to create specific instructions for different areas of your project (monorepo).

Details

Original description by 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.

repo: github/awesome-copilot

Popularity

GitHub stars
40k
Ranking position
#4979
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills