agentleFS
LaurenzVLaurenzV/hayro/AGENTS.md

hayro

AGENTS.md872 starsChanged 4 days agoApache-2.0View on GitHub

  • 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 32,671 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.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Never copy code from other PDF libraries.

    line 8
  2. Distinctive:

    Avoid superlinear algorithms on broken files.

    line 12
  3. Very specific:

    Always run in release mode: cargo test --release -p hayro-tests.

    line 22

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 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

AGENTS.md

Implementation

  • hayro implements specifications (ISO 32000-2, JPEG 2000, JBIG2/T.88, CCITT T.4/T.6, CFF/Type 1/CMap, the PostScript Language Reference). Every behavior must come from what the spec mandates, or be stated as our own choice where the spec says nothing.
  • Other viewers are fine for comparing output, not as a justification. They get things wrong too.
  • Never copy code from other PDF libraries.

Code

  • Malformed or hostile input must never panic, hang, or use unbounded time or memory. Avoid superlinear algorithms on broken files.
  • Comments: none by default. Add one only for a non-obvious why, in one line. No narrating a fix, no spec quotes above checks, no comments explaining what a regression test covers, nothing that only makes sense to someone who saw the diff.
  • Doc comments only on public API: one short line, describing that item only (not what other code does with it). Don't expand existing docs.
  • Order items in a file by importance: public items first, then pub(crate), then private ones, and by importance within each group.

Tests

  • Always run in release mode: cargo test --release -p hayro-tests. Add -- --offline to skip downloads.
  • Commits that change rendering also update tests/references.lock: run HAYRO_CI=1 cargo test --release -p hayro-tests, check that only the expected keys changed in tests/ci/references.lock, then copy it over. CI runs on macOS, so a page can hash differently locally. In that case, take the hash from the CI failure message (rendered hash …). Other machines only pass once a maintainer has uploaded the image for that hash.

Commits and PRs

  • Subject line: <crate>: <Imperative summary>. Use tests: for the test suite and ci: for CI. The PR title is the same as the commit subject, with code identifiers in backticks.
  • PR descriptions say what the problem was and how it's fixed. Benchmark numbers and new tests are welcome. Leave out validation steps and comparisons with other viewers.

Download now (ZIP)

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.