Skip to content

AGENTS.md

Latest commit

 

History

History
64 lines (63 loc) · 3.61 KB

AGENTS.md

File metadata and controls

64 lines (63 loc) · 3.61 KB

AGENTS

  • Read the repo profile selector at .matrixai/repo-profile.yml.
  • Standards are expected at ./.matrixai/matrixai-standards/ from private submodule sync; if access is unavailable, standards and skill updates cannot be refreshed.
  • Enforce the universal hotset .matrixai/matrixai-standards/standards/HOTSET.md.
  • When editing Markdown/prose artifacts, enforce .matrixai/matrixai-standards/standards/prose-markdown.md.
  • Enforce the profile doc under .matrixai/matrixai-standards/standards/profiles/ matching profile: in .matrixai/repo-profile.yml (e.g., library-js, application-js, worker-js-cloudflare, docusaurus-js-cloudflare).
  • Profile index (for discovery): .matrixai/matrixai-standards/standards/profiles/README.md
  • Tooling contract reference: .matrixai/matrixai-standards/standards/coding/tooling/tooling-contract.md (commands, artifacts, expectations per profile).
  • Materialize skills from canonical ./.matrixai/matrixai-standards/skills/** using collection defaults from ./.matrixai/matrixai-standards/skills-collections/** into ./.agents/skills/** for runtime discovery, and rematerialize after standards submodule updates.
  • When using nix run with a flake ref, quote the full flake ref argument (for example, './.matrixai/matrixai-standards#skills-materializer').
  • Profile-driven materialization is the default fast path: run nix run './.matrixai/matrixai-standards#skills-materializer' -- --standards-root ./.matrixai/matrixai-standards and it resolves profile+ecosystem collection defaults into ./.agents/skills/**.
  • Explicit selectors remain optional additive overrides: use --collection ... and/or --root-skill ... only when narrowing or extending selection behavior.
  • Content under ./.matrixai/matrixai-standards/standards/** and ./.matrixai/matrixai-standards/skills/** MUST NOT reference raw exhibits/... intake paths; use stable standards paths (for example ./.matrixai/matrixai-standards/standards/exhibits/...) or source-repo identifiers instead.
  • Prefer ASCII punctuation/symbols when an equivalent exists (see .matrixai/matrixai-standards/standards/HOTSET.md [MXS-GEN-006]).
  • Ensure edits comply with .editorconfig (LF line endings, 2-space indent, final newline, trim trailing whitespace).
  • Line-reference policy (applies to all agent-generated repository content: Markdown, docs, templates, and code comments):
    • Never emit path:line (e.g. foo.ts:1, README.md:126) into repository files.
    • Do NOT put :number inside Markdown link destinations: [x](path:123) is banned.
    • If a line reference is needed, use either:
      • [x](path#heading-anchor) (if possible), or
      • [x](path) (line 123) (preferred, portable), or
      • [x](path#L123) only when explicitly targeting a renderer that supports #L anchors.
    • If you would have emitted :1, drop it entirely: use path with no line info.
  • Apply repo-local golden commands and overrides here (use npm run lintfix during active development; use npm run lint for non-mutating CI checks):
    • build: npm run build
    • test: npm test
    • lintfix: npm run lintfix
    • lint: npm run lint
    • docs: npm run docs
    • bench: (not defined in this repo)