agentleFS
Sign inStart free
SentryKnown publishergetsentry/vitest-evals/AGENTS.md

vitest-evals

AGENTS.md342 starsChanged 52 days agoApache-2.0View on GitHub

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use pnpm: pnpm install, pnpm test, pnpm typecheck, pnpm build, pnpm evals

    line 4
  2. Distinctive:

    Keep normalized session and run data JSON-serializable.

    line 31
  3. Very specific:

    Keep UsageSummary to stable usage units such as tokens, USD cost, tools, retries, provider, and model.

    line 32
  4. Very specific:

    Update README.md, packages/vitest-evals/README.md, and relevant docs when product shape changes.

    line 36
  5. Very specific:

    Follow policies/code-comments.md for exported-function JSDoc and non-obvious comments only.

    line 37

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Instructions

Package Manager

  • Use pnpm: pnpm install, pnpm test, pnpm typecheck, pnpm build, pnpm evals

Repository Structure

packages/
  core/                   # normalized session/run types, transcript events, report metadata
  vitest-evals/           # root describeEval, judges, matchers, reporter, legacy; re-exports core
  harness-ai-sdk/         # AI SDK adapter into HarnessRun
  harness-openai-agents/  # OpenAI Agents adapter into HarnessRun
  harness-pi-ai/          # pi-ai adapter, wrapped tool runtime, tool replay
  github-reporter/        # GitHub Action reporter: collection, summary, annotations
  report-ui/              # HTML report UI and its transcript/trace model
  docs/                   # docs site, generated API reference, llms.txt
apps/                     # demo-ai-sdk, demo-openai-agents, demo-pi (realistic demo fixtures)

File-Scoped Commands

TaskCommand
Lint filepnpm exec biome lint path/to/file.ts
Format filepnpm exec biome format --write path/to/file.ts
Test filepnpm exec vitest run path/to/file.test.ts -c vitest.config.ts
Eval filepnpm exec vitest run path/to/file.eval.ts -c vitest.config.ts --reporter=./packages/vitest-evals/src/reporter.ts

Key Conventions

  • Root API work is harness-first and judge-first.
  • Legacy scorer-first changes stay under packages/vitest-evals/src/legacy/....
  • Keep normalized session and run data JSON-serializable.
  • Keep UsageSummary to stable usage units such as tokens, USD cost, tools, retries, provider, and model. Set costUsd only when cost is known; provider-specific pricing details belong in usage.metadata.
  • GitHub reporting is action-first: document workflows with uses: getsentry/vitest-evals@v0, not CLI commands.
  • Sharded eval reporting uses distinct JSON artifacts per matrix job and one reducer job that publishes the combined action report.
  • Root GitHub Action releases keep source and bundled tags separate: Craft publishes the source release, vX.Y.Z-src preserves the source baseline, and vX/vX.Y.Z point at the bundled action commit. Keep the Craft github target filtered away from package artifacts.
  • Update README.md, packages/vitest-evals/README.md, and relevant docs when product shape changes.
  • Follow policies/code-comments.md for exported-function JSDoc and non-obvious comments only.

Read First

  • docs/architecture.md
  • docs/development-guide.md
  • docs/github-actions.md
  • docs/testing.md
  • policies/README.md
  • policies/code-comments.md

Download now (ZIP)

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free