Skip to content

docs: add AGENTS.md#2338

Open
Aliserag wants to merge 3 commits intomasterfrom
docs/add-agents-md
Open

docs: add AGENTS.md#2338
Aliserag wants to merge 3 commits intomasterfrom
docs/add-agents-md

Conversation

@Aliserag
Copy link
Copy Markdown

Summary

Adds AGENTS.md — the open standard (agents.md, Linux-Foundation-backed, adopted by 60K+ repos) that guides AI coding agents (Claude Code, Codex, Cursor, Copilot, Windsurf, Gemini CLI) on a per-repo basis.

How this file was generated

Authored via an evidence-based generator skill with a strict verify-before-claim protocol:

  • Every build/test command traced to an actual target in Makefile / package.json / equivalent
  • Every file path verified via Glob/Read
  • Every version number pulled from go.mod / package.json / foundry.toml / etc.
  • Every count (targets, scripts, directories) re-executed with the precise command before writing
  • Every line-number citation re-read before writing
  • Internal consistency sweep (no contradictions between sections)
  • Iterated with self-scoring on Coverage / Evidence / Specificity / Conciseness until all four axes reached 10/10

What AGENTS.md contains

  • Overview grounded in README + actual source
  • Build and test commands (only ones that exist in the manifest)
  • Architecture map (real directory layout, real contract/module names)
  • Conventions & gotchas (non-obvious rules verified in source)
  • Files not to modify (generated / vendored / lockfiles)

Test plan

  • File renders on GitHub
  • Every command verified against the relevant manifest
  • Every path verified to exist
  • No approximations or invented commands

Adds the AGENTS.md open-standard file for AI coding agents (agents.md).
Every claim evidence-backed against Makefile, package.json, source tree,
or equivalent manifest. Zero fabrication.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 23, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Aliserag Aliserag requested a review from peterargue April 23, 2026 20:52
The existing AGENTS.md is a strict superset of CLAUDE.md — every
command, architecture note, and convention in CLAUDE.md is already
covered in AGENTS.md, usually in more detail (16 make targets vs
~5, full feature package list, 11 gotchas vs 6 generic conventions,
plus a Files Not to Modify section CLAUDE.md lacks).

Rather than maintain two files that will drift, symlink CLAUDE.md
to AGENTS.md. The agents.md standard explicitly documents this
migration pattern. AGENTS.md is natively supported by Claude Code,
Codex, Cursor, Copilot, Windsurf, and Gemini CLI — so making it the
source of truth expands tool coverage without losing anything, and
the symlink keeps any tooling still hardcoded to look for CLAUDE.md
working unchanged.

Same pattern applied on onflow/flow-ai-tools#33 per @peterargue's
review.
Comment thread CLAUDE.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similar comment here as in the ai-tooling about using @AGENTS.md or using s symlink

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Per review feedback on the sibling flow-ai-tools PR (#33): replace
the CLAUDE.md → AGENTS.md symlink with a plain-text CLAUDE.md whose
single line is the @AGENTS.md import directive.

Claude Code treats @filename as an explicit import that guarantees
the referenced file is loaded, whereas symlink following is
heuristic. The @import approach also avoids Windows / non-Unix
filesystem compatibility issues where symlinks degrade to plain-
text files containing the target path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants