AGENTS.md

1# AGENTS.md
2 
3Guidance for AI coding agents (Claude Code, Codex, Warp, etc.) working in this repository.
4 
5## What this repo is
6 
7A portable agent skill implemented entirely as Markdown. The runtime artifact is `SKILL.md`: the agent reads its YAML frontmatter and editor prompt. There is no build step, and the repo should avoid wording that limits support to one or two harnesses.
8 
9## Key files
10 
11- `SKILL.md` — the skill itself. Portable YAML frontmatter (`name`, `description`, `license`, `metadata.version`) followed by the canonical, numbered pattern list with before/after examples. **This is the source of truth.**
12- `README.md` — for humans: installation, usage, a summary table of the patterns, and a version history.
13- `.claude-plugin/plugin.json` — optional Claude Code plugin manifest.
14- `.claude-plugin/marketplace.json` — optional single-repo marketplace entry so `/plugin marketplace add blader/humanizer` works.
15- `scripts/validate-package.py` — dependency-free package and synchronization checks used locally and in CI.
16 
17## The maintenance contract
18 
19`SKILL.md` and `README.md` must stay in sync. When you change behavior or content:
20 
21- **Patterns:** the skill currently defines **33 numbered patterns**. If you add, remove, or renumber any, update the README pattern table, its "N Patterns Detected" heading, and every cross-reference in the same change. Keep numbering stable unless you are deliberately renumbering.
22- **Version:** `SKILL.md` frontmatter stores the version under `metadata.version`, `README.md` has a "Version History" section, and `.claude-plugin/plugin.json` has a `version` field. Bump them together so package metadata matches the skill. Keep the skill version under `metadata`; a top-level `version` key is not portable across Agent Skills hosts. (`marketplace.json` intentionally omits a version so `plugin.json` stays the package source of truth.)
23- **Compatibility:** keep install and usage language harness-neutral. The skill should work in any agent harness that can load Markdown skill instructions; Claude Code, OpenCode, Codex, and other harnesses are examples, not limits.
24- **Validation:** run `python3 scripts/validate-package.py`, `npx skills add . --list`, and `claude plugin validate .` before publishing.
25- **Non-obvious fixes:** if you change the prompt to handle a tricky failure mode (a repeated mis-edit, an unexpected tone shift), add a short note to the README version history explaining what was fixed and why.
26 
27## Editing SKILL.md
28 
29- Preserve valid YAML frontmatter (formatting and indentation).
30- The prompt below the frontmatter is the product. Edit it like a careful instruction document, not code.
31