acreadiness-generate-instructions

Name: acreadiness-generate-instructions
Author: github

37kstars4.6kforks

How to install acreadiness-generate-instructions?

github/awesome-copilot/acreadiness-generate-instructions

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

Installs into the current project.

Summary

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-ass

Files · 1

View on GitHub

SKILL.md

1	# /acreadiness-generate-instructions — write AI agent instructions
2
3	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.
4
5	## Output options
6
7	VS Code recognises several instruction file types — AgentRC generates the most common ones:
8
9	\| File \| Scope \| When to use \|
10	\|---\|---\|---\|
11	\| `.github/copilot-instructions.md` \| Always-on, whole workspace \| Default — VS Code Copilot's native instruction file \|
12	\| `AGENTS.md` \| Always-on, whole workspace \| Multi-agent repos (Copilot + Claude + others) \|
13	\| `.github/instructions/*.instructions.md` \| Scoped by `applyTo` glob \| Per-area / per-language rules in monorepos \|
14	\| `CLAUDE.md` \| Claude-specific \| Add via `--claude-md` (nested only) \|
15
16	## Strategies
17
18	- `flat` (default) — single `.github/copilot-instructions.md` at the chosen path. Simple, easy to review.
19	- `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.
20
21	> 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.
22
23	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).
24
25	### Topic vs area `.instructions.md` files
26
27	Both end up in `.github/instructions/` but they answer different questions:
28
29	\| Kind \| Filename example \| `applyTo` example \| Where it comes from \|
30	\|---\|---\|---\|---\|
31	\| Topic (nested) \| `testing.instructions.md` \| `*/.{test,spec}.{ts,tsx,js}` \| AgentRC `--strategy nested` topic split \|
32	\| Area (monorepo) \| `frontend.instructions.md` \| `apps/frontend/**` \| `agentrc.config.json` areas + `--areas` \|
33
34	You can have both at once: a nested set of topic files plus per-area files for a monorepo.
35
36	## Per-area files with `applyTo`
37
38	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:
39
40	```markdown
41	---
42	applyTo: "apps/frontend/**"
43	---
44
45	# Frontend area instructions
46
47	…AgentRC-generated content for this area…
48	```
49
50	Workflow:
51
52	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/**`).
53	2. Run `agentrc instructions --areas` (or `--area <name>`) to produce the per-area body content.
54	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.
55	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.
56
57	Naming: lowercase, kebab-case area name. Examples: `.github/instructions/frontend.instructions.md`, `.github/instructions/api.instructions.md`, `.github/instructions/infra.instructions.md`.
58
59	## Steps
60
61	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.
62	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:
63	- Flat (default) — one `.github/copilot-instructions.md`. Simple, easy to review in a single PR. Best for small/medium repos with one stack.
64	- **N

People who liked this also viewed

6 picks

Type

acreadiness-generate-instructions

37kstars4.6kforks

View on GitHub

How to install acreadiness-generate-instructions?

github/awesome-copilot/acreadiness-generate-instructions

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

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# /acreadiness-generate-instructions — write AI agent instructions
2
3	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.
4
5	## Output options
6
7	VS Code recognises several instruction file types — AgentRC generates the most common ones:
8
9	\| File \| Scope \| When to use \|
10	\|---\|---\|---\|
11	\| `.github/copilot-instructions.md` \| Always-on, whole workspace \| Default — VS Code Copilot's native instruction file \|
12	\| `AGENTS.md` \| Always-on, whole workspace \| Multi-agent repos (Copilot + Claude + others) \|
13	\| `.github/instructions/*.instructions.md` \| Scoped by `applyTo` glob \| Per-area / per-language rules in monorepos \|
14	\| `CLAUDE.md` \| Claude-specific \| Add via `--claude-md` (nested only) \|
15
16	## Strategies
17
18	- `flat` (default) — single `.github/copilot-instructions.md` at the chosen path. Simple, easy to review.
19	- `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.
20
21	> 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.
22
23	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).
24
25	### Topic vs area `.instructions.md` files
26
27	Both end up in `.github/instructions/` but they answer different questions:
28
29	\| Kind \| Filename example \| `applyTo` example \| Where it comes from \|
30	\|---\|---\|---\|---\|
31	\| Topic (nested) \| `testing.instructions.md` \| `*/.{test,spec}.{ts,tsx,js}` \| AgentRC `--strategy nested` topic split \|
32	\| Area (monorepo) \| `frontend.instructions.md` \| `apps/frontend/**` \| `agentrc.config.json` areas + `--areas` \|
33
34	You can have both at once: a nested set of topic files plus per-area files for a monorepo.
35
36	## Per-area files with `applyTo`
37
38	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:
39
40	```markdown
41	---
42	applyTo: "apps/frontend/**"
43	---
44
45	# Frontend area instructions
46
47	…AgentRC-generated content for this area…
48	```
49
50	Workflow:
51
52	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/**`).
53	2. Run `agentrc instructions --areas` (or `--area <name>`) to produce the per-area body content.
54	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.
55	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.
56
57	Naming: lowercase, kebab-case area name. Examples: `.github/instructions/frontend.instructions.md`, `.github/instructions/api.instructions.md`, `.github/instructions/infra.instructions.md`.
58
59	## Steps
60
61	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.
62	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:
63	- Flat (default) — one `.github/copilot-instructions.md`. Simple, easy to review in a single PR. Best for small/medium repos with one stack.
64	- **N

People who liked this also viewed

6 picks

Type