@givolt/i3-composer-agent 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/.agents/plugins/marketplace.json +1 -1
  2. package/.claude-plugin/marketplace.json +1 -1
  3. package/.claude-plugin/plugin.json +1 -1
  4. package/.codex-plugin/plugin.json +1 -1
  5. package/README.md +29 -32
  6. package/bin/agent-targets.json +11 -0
  7. package/bin/asset-fingerprint.cjs +38 -0
  8. package/bin/cleanup-backups.cjs +16 -0
  9. package/bin/i3-composer-agent.cjs +27 -12
  10. package/bin/install.cjs +74 -28
  11. package/bin/native-content.cjs +29 -0
  12. package/bin/wizard.cjs +2 -1
  13. package/docs/antigravity-setup.md +1 -1
  14. package/docs/codebuddy-setup.md +11 -3
  15. package/docs/cursor-setup.md +2 -2
  16. package/docs/getting-started.md +0 -2
  17. package/docs/opencode-setup.md +4 -4
  18. package/docs/workbuddy-setup.md +92 -0
  19. package/package.json +36 -20
  20. package/plugin.json +1 -1
  21. package/CHANGELOG.md +0 -51
  22. package/NOTICE.md +0 -15
  23. package/docs/advanced-per-agent-configuration.md +0 -70
  24. package/docs/comparison.md +0 -131
  25. package/docs/developer-onboarding.md +0 -116
  26. package/docs/skill-anatomy.md +0 -203
  27. package/evals/README.md +0 -101
  28. package/evals/cases/i3-api-and-interface-design.json +0 -45
  29. package/evals/cases/i3-browser-testing-with-devtools.json +0 -44
  30. package/evals/cases/i3-ci-cd-and-automation.json +0 -45
  31. package/evals/cases/i3-code-review-and-quality.json +0 -49
  32. package/evals/cases/i3-code-simplification.json +0 -45
  33. package/evals/cases/i3-constraint-driven-development.json +0 -79
  34. package/evals/cases/i3-context-engineering.json +0 -44
  35. package/evals/cases/i3-debugging-and-error-recovery.json +0 -58
  36. package/evals/cases/i3-deprecation-and-migration.json +0 -52
  37. package/evals/cases/i3-documentation-and-adrs.json +0 -44
  38. package/evals/cases/i3-doubt-driven-development.json +0 -43
  39. package/evals/cases/i3-frontend-ui-engineering.json +0 -52
  40. package/evals/cases/i3-git-workflow-and-versioning.json +0 -47
  41. package/evals/cases/i3-idea-refine.json +0 -43
  42. package/evals/cases/i3-incremental-implementation.json +0 -57
  43. package/evals/cases/i3-interview-me.json +0 -42
  44. package/evals/cases/i3-observability-and-instrumentation.json +0 -44
  45. package/evals/cases/i3-performance-optimization.json +0 -53
  46. package/evals/cases/i3-planning-and-task-breakdown.json +0 -45
  47. package/evals/cases/i3-security-and-hardening.json +0 -53
  48. package/evals/cases/i3-shipping-and-launch.json +0 -56
  49. package/evals/cases/i3-source-driven-development.json +0 -44
  50. package/evals/cases/i3-spec-driven-development.json +0 -72
  51. package/evals/cases/i3-test-driven-development.json +0 -73
  52. package/evals/cases/i3-using-agent-skills.json +0 -44
  53. package/evals/fixtures/i3-api-and-interface-design/service-brief.md +0 -19
  54. package/evals/fixtures/i3-browser-testing-with-devtools/README.md +0 -5
  55. package/evals/fixtures/i3-browser-testing-with-devtools/index.html +0 -24
  56. package/evals/fixtures/i3-browser-testing-with-devtools/server.js +0 -15
  57. package/evals/fixtures/i3-ci-cd-and-automation/package.json +0 -8
  58. package/evals/fixtures/i3-ci-cd-and-automation/src/slug.js +0 -3
  59. package/evals/fixtures/i3-ci-cd-and-automation/test/slug.test.js +0 -9
  60. package/evals/fixtures/i3-code-review-and-quality/user-search.diff +0 -16
  61. package/evals/fixtures/i3-code-simplification/config-parser.js +0 -46
  62. package/evals/fixtures/i3-code-simplification/config-parser.test.js +0 -15
  63. package/evals/fixtures/i3-context-engineering/context-audit.md +0 -15
  64. package/evals/fixtures/i3-debugging-and-error-recovery/pagination.js +0 -8
  65. package/evals/fixtures/i3-debugging-and-error-recovery/pagination.test.js +0 -9
  66. package/evals/fixtures/i3-debugging-and-error-recovery/time-pressure.md +0 -6
  67. package/evals/fixtures/i3-deprecation-and-migration/api-inventory.md +0 -9
  68. package/evals/fixtures/i3-documentation-and-adrs/decision-context.md +0 -16
  69. package/evals/fixtures/i3-doubt-driven-development/migration-plan.md +0 -19
  70. package/evals/fixtures/i3-frontend-ui-engineering/Button.tsx +0 -7
  71. package/evals/fixtures/i3-frontend-ui-engineering/design-system.md +0 -11
  72. package/evals/fixtures/i3-git-workflow-and-versioning/.eval/working-tree.patch +0 -21
  73. package/evals/fixtures/i3-git-workflow-and-versioning/app.js +0 -7
  74. package/evals/fixtures/i3-git-workflow-and-versioning/app.test.js +0 -9
  75. package/evals/fixtures/i3-incremental-implementation/reports.js +0 -7
  76. package/evals/fixtures/i3-incremental-implementation/reports.test.js +0 -12
  77. package/evals/fixtures/i3-incremental-implementation/tasks/plan.md +0 -8
  78. package/evals/fixtures/i3-observability-and-instrumentation/operations.md +0 -11
  79. package/evals/fixtures/i3-observability-and-instrumentation/payment-retry.js +0 -14
  80. package/evals/fixtures/i3-performance-optimization/benchmark.js +0 -15
  81. package/evals/fixtures/i3-performance-optimization/products.js +0 -14
  82. package/evals/fixtures/i3-planning-and-task-breakdown/notifications-spec.md +0 -18
  83. package/evals/fixtures/i3-security-and-hardening/webhook.js +0 -11
  84. package/evals/fixtures/i3-security-and-hardening/webhook.test.js +0 -13
  85. package/evals/fixtures/i3-shipping-and-launch/authority-pressure.md +0 -6
  86. package/evals/fixtures/i3-shipping-and-launch/launch-status.md +0 -11
  87. package/evals/fixtures/i3-source-driven-development/framework-task.md +0 -10
  88. package/evals/fixtures/i3-spec-driven-development/billing-brief.md +0 -16
  89. package/evals/fixtures/i3-test-driven-development/BUG.md +0 -10
  90. package/evals/fixtures/i3-test-driven-development/README.md +0 -28
  91. package/evals/fixtures/i3-test-driven-development/package.json +0 -9
  92. package/evals/fixtures/i3-test-driven-development/src/split.js +0 -8
  93. package/evals/fixtures/i3-test-driven-development/test/split.test.js +0 -13
  94. package/evals/fixtures/i3-using-agent-skills/incident.md +0 -6
  95. package/evals/fixtures/incremental-implementation-pressure/draft-export.js +0 -17
  96. package/evals/fixtures/incremental-implementation-pressure/scenario.md +0 -9
  97. package/evals/fixtures/spec-driven-development-decomposition/portal-brief.md +0 -22
  98. package/evals/fixtures/test-driven-development-ecosystem/README.md +0 -9
  99. package/evals/fixtures/test-driven-development-ecosystem/ledger.py +0 -15
  100. package/evals/fixtures/test-driven-development-ecosystem/test_ledger.py +0 -19
  101. package/evals/plugin/code-review-fires/graders/off-by-one.md +0 -7
  102. package/evals/plugin/code-review-fires/graders/severity-labels.md +0 -4
  103. package/evals/plugin/code-review-fires/graders/skill-fired.md +0 -5
  104. package/evals/plugin/code-review-fires/prompt.md +0 -31
  105. package/evals/plugin/code-review-stays-quiet/graders/not-fired.md +0 -8
  106. package/evals/plugin/code-review-stays-quiet/graders/tdd-fired.md +0 -6
  107. package/evals/plugin/code-review-stays-quiet/prompt.md +0 -8
  108. package/evals/plugin/code-review-stays-quiet-on-commit-message/graders/not-fired.md +0 -8
  109. package/evals/plugin/code-review-stays-quiet-on-commit-message/prompt.md +0 -25
  110. package/evals/skill-impact.md +0 -6
  111. package/rebrand/INSTALLATION-SPEC.md +0 -47
  112. package/rebrand/MAINTENANCE.md +0 -114
  113. package/rebrand/NOTICE.md +0 -15
  114. package/rebrand/PR-WORKFLOW.md +0 -34
  115. package/rebrand/PREFIX-SPEC.md +0 -16
  116. package/rebrand/UNIFICATION-SPEC.md +0 -33
  117. package/rebrand/VALIDATION.md +0 -32
  118. package/rebrand/VERSIONING.md +0 -35
  119. package/rebrand/apply.cjs +0 -217
  120. package/rebrand/brand.json +0 -13
  121. package/rebrand/catalog.cjs +0 -70
  122. package/rebrand/fork-patches.json +0 -27
  123. package/rebrand/identifiers.cjs +0 -41
  124. package/rebrand/overlay/.github/workflows/test-plugin-install.yml +0 -177
  125. package/rebrand/overlay/CHANGELOG.md +0 -51
  126. package/rebrand/overlay/bin/agent-targets.json +0 -726
  127. package/rebrand/overlay/bin/i3-composer-agent.cjs +0 -190
  128. package/rebrand/overlay/bin/install.cjs +0 -180
  129. package/rebrand/overlay/bin/skills-registry.LICENSE +0 -21
  130. package/rebrand/overlay/bin/wizard.cjs +0 -66
  131. package/rebrand/overlay/scripts/validate-brand.cjs +0 -44
  132. package/rebrand/overlay/tests/bundle.test.cjs +0 -85
  133. package/rebrand/overlay/tests/installer.test.cjs +0 -241
  134. package/rebrand/package.template.json +0 -82
  135. package/rebrand/rebrand.sh +0 -4
  136. package/rebrand/record-upstream.cjs +0 -37
  137. package/rebrand/templates/README.md +0 -130
  138. package/rebrand/templates/codebuddy-setup.md +0 -89
  139. package/rebrand/templates/codex-setup.md +0 -45
  140. package/rebrand/tests/pipeline.test.cjs +0 -253
  141. package/rebrand/upstream.json +0 -171
  142. package/scripts/floor-guard-reference-test.js +0 -291
  143. package/scripts/lib/skill-lint-test.js +0 -650
  144. package/scripts/lib/skill-lint.js +0 -586
  145. package/scripts/run-evals-test.js +0 -623
  146. package/scripts/run-evals.js +0 -638
  147. package/scripts/validate-artifact-paths-test.js +0 -179
  148. package/scripts/validate-artifact-paths.js +0 -130
  149. package/scripts/validate-brand.cjs +0 -44
  150. package/scripts/validate-commands-test.js +0 -216
  151. package/scripts/validate-commands.js +0 -223
  152. package/scripts/validate-reference-links-test.js +0 -495
  153. package/scripts/validate-reference-links.js +0 -187
  154. package/scripts/validate-skills.js +0 -69
  155. package/scripts/validate-versions-test.js +0 -32
  156. package/scripts/validate-versions.js +0 -35
  157. package/tests/bundle.test.cjs +0 -85
  158. package/tests/installer.test.cjs +0 -241
@@ -1,116 +0,0 @@
1
- # Developer Onboarding
2
-
3
- This guide is for people working **on** the i3-composer-agent repository itself: contributing skills, fixing docs, improving the eval harness. If you want to *use* the skills in your own projects, you're looking for [getting-started.md](getting-started.md) instead.
4
-
5
- It's a guided tour, not a rulebook. The rules live in [CONTRIBUTING.md](../CONTRIBUTING.md) (contribution workflow), [skill-anatomy.md](skill-anatomy.md) (skill format), and [evals/README.md](../evals/README.md) (eval framework); this document tells you when to read each one and how the pieces fit.
6
-
7
- ---
8
-
9
- ## 1. The mental model
10
-
11
- The repo has five composable layers. Understanding what each one is *for* prevents the most common contribution mistakes (putting reference material in a skill, building a persona that routes to other personas, duplicating content across skills).
12
-
13
- | Layer | Location | Job | In one word |
14
- |---|---|---|---|
15
- | **Skills** | `skills/<name>/SKILL.md` | Step-by-step workflows with verification gates | *How* |
16
- | **Personas** | `agents/<role>.md` | Roles with a perspective and output format | *Who* |
17
- | **Commands** | `.claude/commands/`, `.gemini/commands/`, `commands/` | User-facing entry points; the orchestration layer | *When* |
18
- | **References** | `references/*.md` | Checklists skills pull in on demand | *What to check* |
19
- | **Evals** | `evals/cases/<name>.json` | Proof that skills trigger and behave correctly | *Does it work* |
20
-
21
- Two structural rules worth internalizing early:
22
-
23
- - **The user (or a slash command) is the orchestrator.** Personas never invoke other personas; the only endorsed multi-persona pattern is parallel fan-out with a merge step (see [references/orchestration-patterns.md](../references/orchestration-patterns.md)).
24
- - **Don't duplicate, reference.** Skills link to other skills and to `references/` instead of restating content. The same rule applies to docs, including this one.
25
-
26
- One scope caveat that trips people up: `AGENTS.md` and `CLAUDE.md` at the repo root configure agents working on *this repo*. They are not reusable assets and setup guides must never tell users to copy them into their own projects; the reusable assets are the skills.
27
-
28
- Note that commands exist in three parallel directories (Claude Code, Gemini CLI, Antigravity). Touch one and CI checks parity across all of them, see §3.
29
-
30
- ## 2. Local setup
31
-
32
- ```bash
33
- npx @givolt/i3-composer-agent --extract --dir ./i3-composer-agent
34
- cd i3-composer-agent
35
- ```
36
-
37
- There's no build step and no `package.json`; validators are plain Node scripts. You need:
38
-
39
- - **Node 20+** (what CI runs) for the `scripts/` validators
40
- - **bash** (+ `jq` recommended) for the hook regression test
41
- - **`gh` CLI** for the duplicate-PR check before proposing a skill
42
- - **Claude Code** only if you want to run Tier 3 behavioral evals locally
43
-
44
- To try the pack live against a local checkout:
45
-
46
- ```bash
47
- claude --plugin-dir /path/to/i3-composer-agent
48
- ```
49
-
50
- ## 3. The verification loop
51
-
52
- The repo eats its own cooking: verification is non-negotiable for skills, and it's non-negotiable for contributions to the repo too. Everything CI runs, you can run locally in seconds:
53
-
54
- ```bash
55
- # Tier 1, structural: frontmatter, naming, required sections
56
- node scripts/validate-skills.js
57
-
58
- # Command parity and description sync across the three command directories
59
- node scripts/validate-commands.js
60
-
61
- # Tier 2, trigger & routing: positive prompts rank top-k, negatives don't collide
62
- node scripts/run-evals.js
63
-
64
- # Tier 3, behavioral (on demand, spends tokens; --dry-run prints the plan)
65
- node scripts/run-evals.js --behavioral <skill-name> --dry-run
66
-
67
- # Hook regression test, required if you touch hooks/session-start.sh
68
- # or skills/i3-using-agent-skills/SKILL.md
69
- bash hooks/session-start-test.sh
70
- ```
71
-
72
- The three eval tiers are worth understanding even if you never touch the harness, because a red Tier 2 usually means *fix your skill's description*, not the eval: Tier 2 is a lexical approximation of routing (stemmed TF-IDF over descriptions), and its two target failure modes are a description missing the vocabulary users actually say, and an over-broad description that outranks the right skill. The full design, schema, and trust-level rules are in [evals/README.md](../evals/README.md).
73
-
74
- Run the relevant subset before every PR. A PR that arrives green through Tier 1 + Tier 2 + command parity is reviewable; one that doesn't will bounce on mechanics before anyone reads the content.
75
-
76
- ## 4. Contribution paths
77
-
78
- ### Path 1: Fixing or improving an existing skill (most common, best first PR)
79
-
80
- 1. Keep changes focused and minimal; preserve the skill's structure and tone.
81
- 2. If you changed the frontmatter `description`, expect Tier 2 effects; run `node scripts/run-evals.js` and check the skill's trigger prompts still rank.
82
- 3. Run Tier 1 to confirm frontmatter is still valid.
83
-
84
- ### Path 2: Proposing a new skill (higher bar, do the pre-flight)
85
-
86
- The catalog already covers most of the lifecycle, so the burden of proof is on the gap. Before writing anything, run the pre-flight checks in [CONTRIBUTING.md](../CONTRIBUTING.md#before-proposing-a-new-skill): search the catalog, check open PRs (`gh pr list --state open`; near-duplicate clusters already exist), confirm the idea fits [skill-anatomy.md](skill-anatomy.md), and justify the gap explicitly in your PR description. If it overlaps an existing skill, a focused edit to that skill beats a new directory.
87
-
88
- A new skill ships as a set, not a single file: the `skills/<kebab-case-name>/SKILL.md`, a matching `evals/cases/<name>.json`, and a `scripts/` directory only when it ships runnable helpers (reference material goes in `references/`, never inside the skill). The exact frontmatter rules, the section anatomy, and the eval-case minimums live in [CONTRIBUTING.md](../CONTRIBUTING.md#structure) and [skill-anatomy.md](skill-anatomy.md); take them from there rather than this tour, so the two can't drift.
89
-
90
- One point worth internalizing rather than looking up: when writing trigger prompts, paraphrase how users actually talk; copying the description into the prompts games the eval and tells you nothing.
91
-
92
- ### Path 3: Docs, references, harness
93
-
94
- - Docs and skills are **English only**; translations aren't accepted because they drift ([CONTRIBUTING.md](../CONTRIBUTING.md#translations) has the rationale).
95
- - Changes to `scripts/run-evals.js` or the eval schema should stay compatible with skill-creator's `evals.json` schema (adopted verbatim for the behavioral tier; that compatibility is a feature, not an accident).
96
- - Anything touching the session-start hook or the meta-skill it embeds requires the hook regression test (§3).
97
-
98
- ## 5. Pre-PR checklist
99
-
100
- - [ ] Tier 1 green: `node scripts/validate-skills.js`
101
- - [ ] Tier 2 green: `node scripts/run-evals.js`
102
- - [ ] Command parity green if you touched any command directory: `node scripts/validate-commands.js`
103
- - [ ] Hook test green if you touched `hooks/` or `i3-using-agent-skills`
104
- - [ ] New skill → eval case file present with the minimum trigger/behavioral counts
105
- - [ ] New skill → gap justified in the PR description; catalog and open PRs checked
106
- - [ ] No duplicated content; cross-references used instead
107
- - [ ] Change is small and focused (the repo's own `i3-code-review-and-quality` change-sizing guidance applies to contributions here too)
108
-
109
- ## 6. Suggested reading order
110
-
111
- 1. [README.md](../README.md): the catalog and the lifecycle diagram (10 min)
112
- 2. `skills/i3-using-agent-skills/SKILL.md`: how routing works from the agent's side
113
- 3. One well-established skill end to end (e.g. `i3-test-driven-development`): internalize the anatomy by example
114
- 4. [skill-anatomy.md](skill-anatomy.md): the format spec, now with context
115
- 5. [evals/README.md](../evals/README.md): the three tiers and the case format
116
- 6. [CONTRIBUTING.md](../CONTRIBUTING.md) + [AGENTS.md](../AGENTS.md): the rules and the repo-scoped agent config
@@ -1,203 +0,0 @@
1
- # Skill Anatomy
2
-
3
- This document describes the structure and format of i3-composer-agent skill files. Use this as a guide when contributing new skills or understanding existing ones.
4
-
5
- ## File Location
6
-
7
- Every skill lives in its own directory under `skills/`:
8
-
9
- ```
10
- skills/
11
- skill-name/
12
- SKILL.md # Required: The skill definition
13
- scripts/ # Optional: Runnable helpers used by the skill workflow
14
- references/ # Optional: Skill-specific reference documentation
15
- supporting-file.md # Optional: Reference material loaded on demand
16
- ```
17
-
18
- `SKILL.md` is the only required file. Add `scripts/` or `references/` only when the skill actually needs them, and omit them entirely for simpler skills.
19
-
20
- ## SKILL.md Format
21
-
22
- ### Frontmatter (Required)
23
-
24
- ```yaml
25
- ---
26
- name: skill-name-with-hyphens
27
- description: Guides agents through [task/workflow]. Use when [specific trigger conditions].
28
- ---
29
- ```
30
-
31
- **Rules:**
32
- - `name`: Lowercase, hyphen-separated. Must match the directory name.
33
- - `description`: Start with what the skill does in third person, then include one or more clear "Use when" trigger conditions. Include both *what* and *when*. Maximum 1024 characters.
34
- - Top-level keys are limited to the [Agent Skills specification](https://agentskills.io) fields: `name`, `description`, `license`, `compatibility`, `metadata`, and `allowed-tools`. Vendor or runtime controls such as `model`, `tools`, `max_turns`, or `context` go under `metadata` or in a per-agent adapter file; see [docs/advanced-per-agent-configuration.md](advanced-per-agent-configuration.md). The validator rejects any other top-level key.
35
-
36
- Published names are compatibility identifiers. In particular,
37
- `i3-browser-testing-with-devtools` is the stable upstream name because other
38
- skills refer to it directly. A downstream catalog may rename it, but that
39
- catalog owns the alias or migration mapping; downstream-only aliases are not
40
- maintained in this repository.
41
-
42
- **Why this matters:** Agents discover skills by reading descriptions. The description is injected into the system prompt, so it must tell the agent both what the skill provides and when to activate it. Do not summarize the workflow — if the description contains process steps, the agent may follow the summary instead of reading the full skill.
43
-
44
- ### Standard Sections (Recommended Pattern)
45
-
46
- The frontmatter contract above is required. The section layout below is a recommended pattern, not a rigid template: equivalent headings are acceptable when they serve the same purpose clearly.
47
-
48
- ```markdown
49
- # Skill Title
50
-
51
- ## Overview
52
- One-two sentences explaining what this skill does and why it matters.
53
-
54
- ## When to Use
55
- - Bullet list of triggering conditions (symptoms, task types)
56
- - When NOT to use (exclusions)
57
-
58
- ## [Core Process / The Workflow / Steps]
59
- The main workflow, broken into numbered steps or phases.
60
- Include code examples where they help.
61
- Use flowcharts (ASCII) where decision points exist.
62
-
63
- ## [Specific Techniques / Patterns]
64
- Detailed guidance for specific scenarios.
65
- Code examples, templates, configuration.
66
-
67
- ## Common Rationalizations
68
- | Rationalization | Reality |
69
- |---|---|
70
- | Excuse agents use to skip steps | Why the excuse is wrong |
71
-
72
- ## Red Flags
73
- - Behavioral patterns indicating the skill is being violated
74
- - Things to watch for during review
75
-
76
- ## Verification
77
- After completing the skill's process, confirm:
78
- - [ ] Checklist of exit criteria
79
- - [ ] Evidence requirements
80
- ```
81
-
82
- ## Section Purposes
83
-
84
- ### Overview
85
- The "elevator pitch" for the skill. Should answer: What does this skill do, and why should an agent follow it?
86
-
87
- ### When to Use
88
- Helps agents and humans decide if this skill applies to the current task. Include both positive triggers ("Use when X") and negative exclusions ("NOT for Y").
89
-
90
- ### Core Process
91
- The heart of the skill. This is the step-by-step workflow the agent follows. Must be specific and actionable — not vague advice.
92
-
93
- **Good:** "Run `npm test` and verify all tests pass"
94
- **Bad:** "Make sure the tests work"
95
-
96
- ### Common Rationalizations
97
- The most distinctive feature of well-crafted skills. These are excuses agents use to skip important steps, paired with rebuttals. They prevent the agent from rationalizing its way out of following the process.
98
-
99
- Think of every time an agent has said "I'll add tests later" or "This is simple enough to skip the spec" — those go here with a factual counter-argument.
100
-
101
- ### Red Flags
102
- Observable signs that the skill is being violated. Useful during code review and self-monitoring.
103
-
104
- ### Verification
105
- The exit criteria. A checklist the agent uses to confirm the skill's process is complete. Every checkbox should be verifiable with evidence (test output, build result, screenshot, etc.).
106
-
107
- ## Supporting Files
108
-
109
- Create supporting files only when:
110
- - Reference material exceeds 100 lines (keep the main SKILL.md focused)
111
- - Code tools or scripts are needed
112
- - Checklists are long enough to justify separate files
113
-
114
- Keep patterns and principles inline when under 50 lines.
115
-
116
- If a skill does not need runnable helpers, do not create an empty `scripts/` directory just to mirror other skills. Empty directories add noise without changing how the skill works.
117
-
118
- ## Shared References
119
-
120
- Checklists used by more than one skill — testing, security, performance, accessibility, definition-of-done — live in `references/` at the repository root, deliberately *not* inside any skill directory.
121
-
122
- This is a pack-level design choice. The Agent Skills spec describes a skill as a self-contained directory, but several skills here point at the same checklists. Colocating those would force one of two options: copy the checklist into every skill that uses it, or pick one skill to "own" it and have the others reach into that directory. Both drift over time. A single repo-root copy stays the source of truth.
123
-
124
- The tradeoff is portability: a whole-repo install (such as the Claude Code marketplace plugin) carries `references/` along, but a per-skill install that copies only `skills/<name>/` leaves the repo-root sibling behind, and those links resolve to nothing. That gap is tracked in [upstream agent-skills #361](https://github.com/addyosmani/agent-skills/issues/361).
125
-
126
- Current convention: material used by exactly one skill is a supporting file inside that skill's directory; material shared across skills goes in `references/`.
127
-
128
- ## Context Efficiency
129
-
130
- Skills load on demand: only the skill name and description sit in context at startup. The full `SKILL.md` loads only when an agent decides the skill is relevant. To keep that load cheap:
131
-
132
- - **Keep `SKILL.md` under 500 lines.** Move detailed reference material into supporting files.
133
- - **Write specific descriptions.** A precise description helps the agent activate the skill at the right moment and skip it otherwise.
134
- - **Use progressive disclosure.** Reference supporting files that are read only when the workflow reaches them.
135
- - **Prefer scripts over inline code.** Executing a script consumes no context; only its output does. Inline code blocks are paid for on every load.
136
- - **Keep file references one level deep.** Link directly from `SKILL.md` to supporting files rather than chaining through intermediate documents.
137
-
138
- ## Script Requirements
139
-
140
- When a skill ships runnable helpers under `scripts/`, each script follows these conventions:
141
-
142
- - Use a `#!/bin/bash` shebang.
143
- - Use `set -e` for fail-fast behavior.
144
- - Write status messages to stderr: `echo "Message" >&2`.
145
- - Write machine-readable output (JSON) to stdout.
146
- - Include a cleanup trap for temporary files.
147
- - Reference the script path as `skills/<skill-name>/scripts/<script>.sh` (repo-relative).
148
-
149
- ## Writing Principles
150
-
151
- 1. **Process over knowledge.** Skills are workflows, not reference docs. Steps, not facts.
152
- 2. **Specific over general.** "Run `npm test`" beats "verify the tests".
153
- 3. **Evidence over assumption.** Every verification checkbox requires proof.
154
- 4. **Anti-rationalization.** Every skip-worthy step needs a counter-argument in the rationalizations table.
155
- 5. **Progressive disclosure.** Main SKILL.md is the entry point. Supporting files are loaded only when needed.
156
- 6. **Token-conscious.** Every section must justify its inclusion. If removing it wouldn't change agent behavior, remove it.
157
- 7. **Model-neutral.** Write the procedure, not the workaround. See [Write the Procedure, Not the Workaround](#write-the-procedure-not-the-workaround).
158
-
159
- ## Write the Procedure, Not the Workaround
160
-
161
- Skills in this pack run on many agents and model generations. A step that exists because one model gets a specific call wrong is a liability on every other model: it constrains agents that would have solved the task directly, and it spends turns that stronger models need for the actual work. Cross-model transfer measurements ([WikiSkill, arXiv:2608.27454](https://arxiv.org/abs/2608.27454)) show skills authored against one model's execution failures can leave a stronger model performing *worse than with no skill at all*.
162
-
163
- **The rule:** if a step cannot be justified without naming a model, a model version, or one agent's private tool name, it belongs in an issue, not in a skill. Describe the capability ("run the focused test command", "write the file"), not the mechanism one runtime happens to expose (`run_command`, `write_to_file`).
164
-
165
- Two smells to check for before proposing skill content:
166
-
167
- - **Over-specified mechanics.** Prescribing an exact command form or serialization detail where stating the goal alone would do. If the justification is "model X gets this wrong otherwise", it's a workaround, not a procedure.
168
- - **Fragmented diagnostics.** A multi-step inspection sequence where one step would confirm the same thing. Every extra step spends turns, and turn budget is finite.
169
-
170
- This is about skill *content*; the portability of `references/` *paths* is a separate concern (see [Shared References](#shared-references)).
171
-
172
- ## Naming Conventions
173
-
174
- - Skill directories: `lowercase-hyphen-separated`
175
- - Skill files: `SKILL.md` (always uppercase)
176
- - Supporting files: `lowercase-hyphen-separated.md`
177
- - Shared references: stored in the root `references/` directory, not inside skill directories (see [Shared References](#shared-references) for why).
178
- - Skill-specific references: a single supporting doc can stay as a loose file in the skill directory (the `Supporting files` entry above); when several related docs travel with the skill, the emerging convention for self-contained, distributable skills is to group them in a `references/` directory inside the skill directory, so the skill carries its own supporting docs.
179
-
180
- ## Cross-Skill References
181
-
182
- Reference other skills by name:
183
-
184
- ```markdown
185
- Follow the `i3-test-driven-development` skill for writing tests.
186
- If the build breaks, use the `i3-debugging-and-error-recovery` skill.
187
- ```
188
-
189
- Don't duplicate content between skills — reference and link instead.
190
-
191
- ## Required vs Recommended
192
-
193
- Required:
194
-
195
- - A `skills/<skill-name>/SKILL.md` file
196
- - Valid YAML frontmatter with `name` and `description`
197
- - A description that includes both what the skill does and when to use it
198
-
199
- Recommended:
200
-
201
- - The standard section flow shown above
202
- - Equivalent headings such as `How It Works`, `Core Process`, or `Workflow` when they read more naturally for the skill
203
- - Supporting files only when they keep the main `SKILL.md` focused
package/evals/README.md DELETED
@@ -1,101 +0,0 @@
1
- # Skill Evals
2
-
3
- How this repo measures whether its skills actually work: that they **trigger** when they should, **stay distinct** from each other, and **change agent behavior** the way each skill promises.
4
-
5
- ## Prior art (and what we adopted)
6
-
7
- There is no single settled community standard for evaluating `SKILL.md` skills, but two approaches lead:
8
-
9
- - **Anthropic's skill-creator v2** defines a per-skill `evals.json` (prompt + `expectations[]`, graded from the transcript) plus trigger-accuracy testing of descriptions against sample prompts. We adopt its [`evals.json` schema](https://github.com/anthropics/skills/tree/main/skills/skill-creator) for our behavioral tier and add one optional `kind` field to select the artifact being graded.
10
- - **Superpowers** (obra) tests skills with bash + `claude -p` + prompt fixtures and grader scripts. Our behavioral runner follows the same headless-`claude` pattern, with the grading rubric drawn from `expectations[]`.
11
-
12
- What neither provides is a **deterministic, CI-safe** check for a multi-skill *catalog* — does each skill's description carry the vocabulary users actually say, and do two skills' descriptions collide? That's Tier 2 below, and it's this repo's addition.
13
-
14
- ## The three tiers
15
-
16
- | Tier | What it checks | Runs | Cost |
17
- |---|---|---|---|
18
- | 1. Structural | Frontmatter, naming, required sections, command parity | CI (`validate-skills.js`, `validate-commands.js`) | Free |
19
- | 2. Trigger & routing | Positive prompts rank their skill top-k; negative prompts don't; no two descriptions near-collide | CI (`run-evals.js`) | Free |
20
- | 3. Behavioral | An agent following the skill satisfies its `expectations[]` | On demand (`run-evals.js --behavioral`) | Tokens |
21
-
22
- Tier 2 is a **lexical approximation** of routing (stemmed TF-IDF over descriptions). It cannot judge semantics — that's Tier 3's job — but it catches the two failure modes that dominate real trigger bugs: a description missing the vocabulary users say (false negative), and an over-broad description that outranks the right skill (false positive). A Tier-2 failure usually means *fix the description*, not the eval.
23
-
24
- ## Running
25
-
26
- ```bash
27
- # Tier 2 — deterministic, runs in CI
28
- node scripts/run-evals.js
29
- node scripts/run-evals.js --min-rank1 95 # enforce the current routing floor
30
-
31
- # Tier 3 — behavioral, runs each eval through headless claude, then grades it
32
- node scripts/run-evals.js --behavioral test-driven-development # spends tokens
33
- node scripts/run-evals.js --behavioral test-driven-development --dry-run # prints the plan only
34
- ```
35
-
36
- Tier 3 supports two behavioral artifact kinds. `execution` is the default: each eval runs in a throwaway git repository, real project inputs from `files[]` are materialized out of `evals/fixtures/` and committed as the baseline, and the grader judges the full `--output-format stream-json --verbose` execution trace, including tool calls. `dialogue` is reserved for skills whose deliverable is the conversation itself; it needs no fixture, and the grader judges the assistant's conversational turns without requiring file edits or commands. Claiming `dialogue` is a human-reviewed exemption, not a general escape hatch for execution skills.
37
-
38
- The executor runs with an explicit permission mode (`--permission-mode acceptEdits` plus a pre-approved tool list) so execution evals can genuinely edit files, run commands, inspect diffs, and make commits rather than being denied and narrating instead. Traces are fenced as untrusted data in the grader prompt and piped to the grader over stdin (they can be megabytes; argv would hit the OS argument-size limit), executor and grader calls carry timeouts, and grader output is validated as JSON before being written to `evals/results/` (gitignored) in skill-creator's `grading.json` shape. Discipline skills also include pressure cases for time pressure, sunk cost, and authority pressure; these verify that the workflow still holds when the prompt argues for skipping it.
39
-
40
- ## Plugin evals (Claude Code)
41
-
42
- `claude plugin eval` (Claude Code 2.1.269 or later) loads the whole plugin, every skill at once, runs the cases under `evals/plugin/`, and scores each case with and without the plugin. It complements Tier 2 rather than replacing it: Tier 2 checks that a description carries the vocabulary users say; this checks that Claude Code's own router picks the skill on a natural prompt, and what the skill adds to the reply (the `Δ` column).
43
-
44
- ```bash
45
- claude plugin eval . --no-publish # every case, both arms, 3 runs each
46
- claude plugin eval . --case code-review-fires --runs 1 --ablation none # one cheap iteration on one case
47
- ```
48
-
49
- A case is a directory holding `prompt.md` (frontmatter: turn and tool limits; body: the prompt, sent verbatim) and one grader per file under `graders/`. Reports land in `evals/plugin/results/<timestamp>/`, already gitignored. Every run and every `llm` grader is a real model call on your account, so this runs on demand and never in CI, like Tier 3.
50
-
51
- Two rules keep it honest. The manifest's `experimental.evals` key scopes the scan to `evals/plugin/`, so a fixture elsewhere under `evals/` is never read as a case. And a `tool_used: Skill` grader only says whether the skill fired; in a two-arm run it is excluded from the score, so pair it with a grader on the reply itself. `code-review-fires` shows the pattern: the fired indicator, a free `regex` grader that looks for the skill's severity taxonomy (Critical, Required, Nit, Optional, Consider, FYI) used as a heading or as a label, and one `llm` judge on the planted off-by-one. `code-review-stays-quiet` is the precision check: the review skill must not fire on a test-first request, and its `Δ` is expected to be 0; a second, unscored indicator records whether test-driven-development fires instead.
52
-
53
- What the first runs taught (Claude Code 2.1.278, claude-opus-5). Skill invocation is stochastic: the review skill fired in 5 of 7 runs on the phrasing the case uses, and test-driven-development fired in 2 of 7 runs on the test-first prompt, so read `Δ` and the report rather than the exit code, or pass `--threshold 0.8` as the CI example in the docs does. In one run the review skill did not fire and the reply still used its severity taxonomy as headings, which no baseline run did in nine; the loaded skill descriptions may shape the reply even without an invocation. Phrasing matters, and the description is the lever. With the original description, "Review this diff before I merge it", "Can you do a proper code review of this change before I merge it?" and "Review this pull request for me before it goes into main" rarely fired the skill; the model reviewed the diff on its own, competently but without the verdict, the severity tiers or the five-axis pass. Describing what the skill adds did not help, and neither did naming diffs and pull requests on their own; what made the difference was saying that the skill applies even when the diff is pasted inline, which is the case the model was treating as "I can just do this myself". On claude-opus-5-5 with the model pinned, that one clause took the four review phrasings from 7 of 27 fires to 21 of 27, left the nine adjacent must-not-fire prompts at 0 of 27 both ways, and moved the plainest phrasing from 0 of 9 to 3 of 9, so it is better, not solved. `code-review-stays-quiet-on-commit-message` guards that clause: a pasted diff with a commit-message request must not fire the review skill. Two practical rules from the same day: pin `--model` and record the Claude Code version whenever you report numbers, because the CLI updates itself and the default model changed twice between morning and evening; and give a case a turn budget of 10 or more, since the model may reach a skill through its slash command (`agent-skills:review`, then `code-review-and-quality`), which costs two turns.
54
-
55
- ## Eval case format
56
-
57
- One file per skill: `evals/cases/<skill-name>.json`.
58
-
59
- ```json
60
- {
61
- "skill_name": "test-driven-development",
62
- "trigger": {
63
- "positive": [
64
- { "prompt": "Write a failing test for this bug before fixing it", "top_k": 3 }
65
- ],
66
- "negative": [
67
- { "prompt": "Update the architecture diagram in the docs", "owner": "documentation-and-adrs" }
68
- ]
69
- },
70
- "evals": [
71
- {
72
- "id": 1,
73
- "kind": "execution",
74
- "prompt": "Finance filed the reconciliation bug written up in BUG.md. Fix it.",
75
- "expected_output": "A failing reproduction test for the lost-cent case, a fix preserving both README invariants (exact sum, earliest-shares fairness), the fairness invariant covered by its own test, full suite passing",
76
- "files": [
77
- "test-driven-development"
78
- ],
79
- "expectations": [
80
- "A test reproducing the lost-cent case from BUG.md is added and shown failing before src/split.js is modified",
81
- "The final implementation satisfies the full README fairness invariant (leftover cents go to the earliest shares): splitCents(10000, 3) returns [3334, 3333, 3333] as BUG.md expects and splitCents(100, 7) returns [15, 15, 14, 14, 14, 14, 14] as the README example shows; dumping the whole remainder on a single share would violate both",
82
- "The fairness invariant from the README has its own test case in the suite on an input with remainder of at least 2 (such as splitCents(100, 7)), where dumping the whole remainder on one share would fail it, beyond the reported lost-cent case",
83
- "The full suite is run with the repository's own command after the fix"
84
- ]
85
- }
86
- ]
87
- }
88
- ```
89
-
90
- - `evals[]` uses skill-creator's core schema (`id`, `prompt`, `expected_output`, optional `files[]`, `expectations[]`) plus this repository's optional `kind`. `kind` must be `execution` or `dialogue` and defaults to `execution` for compatibility. Execution evals require non-empty `files[]`; paths are relative to `evals/fixtures/` and may name a file or project directory. Dialogue evals may omit `files[]` because the transcript is the artifact. Expectations are verifiable statements a grader checks against the relevant artifact — behaviors, not phrasings.
91
- - `trigger` is this repo's extension. `positive` prompts are realistic user asks that should route here (`top_k` defaults to 3; tighten to 1 for a skill's signature ask). `negative` prompts belong to a *different* skill; this skill must not rank first for them. Declare that skill in `owner` where you can: the runner then asserts the owner **outranks** this skill, turning the negative into a real pairwise routing test instead of one that can pass vacuously when the prompt matches nothing.
92
-
93
- **Writing good trigger prompts:** paraphrase how users actually talk; don't copy the description (that's gaming the eval). If a realistic prompt can't rank because the description lacks its vocabulary, that is a real finding — improve the description.
94
-
95
- ## Adding a skill
96
-
97
- Every skill ships with an eval file. When you add `skills/<name>/`, add `evals/cases/<name>.json` with at least 3 positive triggers, 2 negative triggers, and 1 behavioral eval. Execution evals must be backed by `evals/fixtures/<name>/`; use `kind: "dialogue"` only when the skill's deliverable is genuinely the conversation itself. Missing case files, incomplete case counts, unknown kinds, invalid fixture paths, and absent required fixtures are CI errors.
98
-
99
- ## Metrics to watch
100
-
101
- The Tier-2 run prints a **trigger rank-1 rate** (share of positive prompts that rank their skill first, not merely top-k). CI runs with `--min-rank1 95`, leaving useful headroom below the checked-in 100% baseline so an unrelated description edit does not immediately turn CI red. Raise the floor as routing improves; never lower it to make a regression pass. Falling numbers mean descriptions are drifting toward each other. The collision check errors at ≥75% pairwise description similarity and warns at ≥50%. When these evals surface a description-vocabulary gap (see [#351](https://github.com/addyosmani/agent-skills/issues/351) for the original examples), fix the description, not the prompt.
@@ -1,45 +0,0 @@
1
- {
2
- "skill_name": "i3-api-and-interface-design",
3
- "trigger": {
4
- "positive": [
5
- {
6
- "prompt": "Design a REST endpoint for creating invoices, including error responses and versioning",
7
- "top_k": 3
8
- },
9
- {
10
- "prompt": "What should the public interface of this payments module expose to other teams?",
11
- "top_k": 3
12
- },
13
- {
14
- "prompt": "Help me define the contract between the frontend and the orders service",
15
- "top_k": 3
16
- }
17
- ],
18
- "negative": [
19
- {
20
- "prompt": "My unit test is failing with a null pointer exception",
21
- "owner": "i3-debugging-and-error-recovery"
22
- },
23
- {
24
- "prompt": "Make this landing page responsive on mobile",
25
- "owner": "i3-frontend-ui-engineering"
26
- }
27
- ]
28
- },
29
- "evals": [
30
- {
31
- "id": 1,
32
- "prompt": "Design the public API for a URL-shortening service: create, resolve, stats. Produce the endpoint contracts.",
33
- "expected_output": "Endpoint contracts with methods, paths, request/response shapes, and explicit error semantics",
34
- "files": [
35
- "i3-api-and-interface-design"
36
- ],
37
- "expectations": [
38
- "Error responses are specified with status codes and a consistent error shape, not just happy paths",
39
- "Input validation at the boundary is addressed for user-supplied URLs",
40
- "Versioning or compatibility strategy is stated",
41
- "The response does not silently invent unstated requirements"
42
- ]
43
- }
44
- ]
45
- }
@@ -1,44 +0,0 @@
1
- {
2
- "skill_name": "i3-browser-testing-with-devtools",
3
- "trigger": {
4
- "positive": [
5
- {
6
- "prompt": "Use Chrome DevTools to figure out why the checkout button click does nothing",
7
- "top_k": 3
8
- },
9
- {
10
- "prompt": "Inspect the network requests the dashboard makes when it first loads",
11
- "top_k": 3
12
- },
13
- {
14
- "prompt": "Verify in a real browser that the form submits and the data persists in localStorage",
15
- "top_k": 3
16
- }
17
- ],
18
- "negative": [
19
- {
20
- "prompt": "Write a spec for the new billing feature before we start",
21
- "owner": "i3-spec-driven-development"
22
- },
23
- {
24
- "prompt": "Break this PRD into ordered implementation tasks",
25
- "owner": "i3-planning-and-task-breakdown"
26
- }
27
- ]
28
- },
29
- "evals": [
30
- {
31
- "id": 1,
32
- "prompt": "The signup form renders but submitting it appears to do nothing. Verify the real behavior in the browser and report findings.",
33
- "expected_output": "Runtime evidence from the browser: console errors, network activity, DOM state, and a diagnosis",
34
- "files": [
35
- "i3-browser-testing-with-devtools"
36
- ],
37
- "expectations": [
38
- "Findings are grounded in observed runtime data (console, network, DOM), not static code reading alone",
39
- "The report distinguishes what was observed from what is inferred",
40
- "A concrete next step or fix hypothesis is provided"
41
- ]
42
- }
43
- ]
44
- }
@@ -1,45 +0,0 @@
1
- {
2
- "skill_name": "i3-ci-cd-and-automation",
3
- "trigger": {
4
- "positive": [
5
- {
6
- "prompt": "Set up a GitHub Actions pipeline that runs the tests on every pull request",
7
- "top_k": 3
8
- },
9
- {
10
- "prompt": "Add a deploy stage to the pipeline with a manual approval gate",
11
- "top_k": 3
12
- },
13
- {
14
- "prompt": "Automate the quality gates so nothing merges without passing checks",
15
- "top_k": 3
16
- }
17
- ],
18
- "negative": [
19
- {
20
- "prompt": "Refactor this function so it is easier to read",
21
- "owner": "i3-code-simplification"
22
- },
23
- {
24
- "prompt": "Add structured logging to the checkout service",
25
- "owner": "i3-observability-and-instrumentation"
26
- }
27
- ]
28
- },
29
- "evals": [
30
- {
31
- "id": 1,
32
- "prompt": "Create a CI pipeline for a Node project: install, lint, test on every PR, and block merge on failure.",
33
- "expected_output": "A working workflow definition with correct triggers, steps, and failure behavior",
34
- "files": [
35
- "i3-ci-cd-and-automation"
36
- ],
37
- "expectations": [
38
- "The workflow triggers on pull requests",
39
- "Failure of any quality gate fails the pipeline run",
40
- "Steps are ordered logically and cache or setup steps are sane",
41
- "No secrets are hardcoded in the workflow"
42
- ]
43
- }
44
- ]
45
- }
@@ -1,49 +0,0 @@
1
- {
2
- "skill_name": "i3-code-review-and-quality",
3
- "trigger": {
4
- "positive": [
5
- {
6
- "prompt": "Review this pull request before I merge it",
7
- "top_k": 3
8
- },
9
- {
10
- "prompt": "Do a quality pass on this diff for correctness and readability",
11
- "top_k": 3
12
- },
13
- {
14
- "prompt": "Can you review the changes another model just wrote for me?",
15
- "top_k": 3
16
- },
17
- {
18
- "prompt": "Review this diff before I merge it. It adds paging to the orders endpoint.",
19
- "top_k": 3
20
- }
21
- ],
22
- "negative": [
23
- {
24
- "prompt": "Deploy this to production now",
25
- "owner": "i3-shipping-and-launch"
26
- },
27
- {
28
- "prompt": "Write a failing test for the bug before fixing it",
29
- "owner": "i3-test-driven-development"
30
- }
31
- ]
32
- },
33
- "evals": [
34
- {
35
- "id": 1,
36
- "prompt": "Review the provided diff that adds a user-search endpoint. Deliver a structured review.",
37
- "expected_output": "A multi-axis review with severity-labelled findings and file:line references",
38
- "files": [
39
- "i3-code-review-and-quality"
40
- ],
41
- "expectations": [
42
- "Findings cover more than one axis (correctness, readability, architecture, security, performance)",
43
- "Every finding carries a severity label from the skill's taxonomy",
44
- "Security of user input is explicitly considered for the new endpoint",
45
- "The review leads with high-leverage findings rather than nits"
46
- ]
47
- }
48
- ]
49
- }