agentleFS
Sign inStart free
ziggy42ziggy42/epsilon/AGENTS.md

epsilon

AGENTS.md439 starsChanged 5 months agoApache-2.0View on GitHub

Epsilon is a pure-Go, zero-CGo Wasm 2.0 runtime, usable both as an embeddable library and as a CLI. Layout: - epsilon/ — the public, importable package: parser, validation, the VM instruction loop, and memory/table/global/host-import machinery. Exported symbols here are the library's public API; treat signature changes as breaking. - wasip1/ — WASI Preview 1 host implementation. - cmd/epsilon/ — the CLI entry point. - internal/spec_tests/ — Wasm spec conformance runner. - internal/benchmarks/ — the benchmark suite. - Correctness, Performance &…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

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

    Dependencies: No third-party dependencies except golang.org/x, and no CGo.

    line 24
  2. Distinctive:

    Comments: Write self-explanatory code.

    line 26
  3. Distinctive:

    Line Width: Keep lines within 80 columns, counting a tab as 2 columns.

    line 29
  4. Distinctive:

    Security: Treat Wasm modules and host inputs as untrusted.

    line 31
  5. Very specific:

    Naming Conventions: Use self-explanatory variable names (e.g., use name instead of n).

    line 34
  6. Very specific:

    Commit Messages: Do not use conventional commit prefixes (e.g., chore:, feat:, fix:, docs:).

    line 39
  7. Very specific:

    Commit Authors: No agent co-author trailers (e.g.

    line 41
  8. Distinctive:

    Prefer reusing buffers/slices where possible.

    line 52
  9. Very specific:

    Check for regressions with make bench when touching hot paths.

    line 53

≈ “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

Project Overview

Epsilon is a pure-Go, zero-CGo Wasm 2.0 runtime, usable both as an embeddable library and as a CLI. Layout:

  • epsilon/ — the public, importable package: parser, validation, the VM instruction loop, and memory/table/global/host-import machinery. Exported symbols here are the library's public API; treat signature changes as breaking.
  • wasip1/ — WASI Preview 1 host implementation.
  • cmd/epsilon/ — the CLI entry point.
  • internal/spec_tests/ — Wasm spec conformance runner.
  • internal/benchmarks/ — the benchmark suite.

Core Values

  • Correctness, Performance & Security: Absolute top priorities. When in doubt, consult the user on which to prioritize.
  • Simplicity: Secondary priority; must not be achieved at the expense of correctness, performance or security.

General Rules

  • Dependencies: No third-party dependencies except golang.org/x, and no CGo.
  • Comments: Write self-explanatory code; only add comments for non-obvious logic. Doc comments state what a symbol is or does, not how, where, or by whom it is used.
  • Line Width: Keep lines within 80 columns, counting a tab as 2 columns. Fill comment lines greedily — don't wrap early.
  • Security: Treat Wasm modules and host inputs as untrusted. The validator is the trust boundary the VM relies on — never weaken or skip its checks. Invalid input must surface as a Go error, never a panic.
  • Naming Conventions: Use self-explanatory variable names (e.g., use name instead of n).

Git & Commits

  • Commit Messages: Do not use conventional commit prefixes (e.g., chore:, feat:, fix:, docs:). Use plain, descriptive language.
  • Commit Authors: No agent co-author trailers (e.g. Co-Authored-By: Claude …).

Project Specifics

  • Build & test: The root Makefile is the entry point (make help lists all targets). Before considering a change complete, run make fmt, make vet, and make test-all and make sure they pass; if you changed Markdown, also run make fmt-md.
  • Performance:
    • Minimize heap allocations in the hot path (VM instruction loop).
    • Prefer reusing buffers/slices where possible.
    • Check for regressions with make bench when touching hot paths.

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