Skip to content

docs: add AGENTS.md#658

Open
Aliserag wants to merge 2 commits intomainfrom
docs/add-agents-md
Open

docs: add AGENTS.md#658
Aliserag wants to merge 2 commits intomainfrom
docs/add-agents-md

Conversation

@Aliserag
Copy link
Copy Markdown
Contributor

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.
@Aliserag Aliserag requested a review from turbolent as a code owner April 23, 2026 20:36
@Aliserag Aliserag requested a review from peterargue April 23, 2026 20:51
Comment thread AGENTS.md Outdated
Per @turbolent's review feedback on PR #658: reference the
CODEOWNERS file rather than listing its members inline. The hard-
coded member list would silently go stale when the team rotates
reviewers, since GitHub enforces CODEOWNERS but nothing enforces
AGENTS.md. Matches the pattern already used by the surrounding
bullets (which cite codecov.yml / SECURITY.md / CONTRIBUTING.md /
ci.yml without duplicating their contents).
Aliserag added a commit to onflow/cadence that referenced this pull request Apr 23, 2026
Per review feedback on the sibling atree PR (onflow/atree#658),
reference the CODEOWNERS file rather than listing its members
inline. The hard-coded list would silently go stale when the team
rotates reviewers, since GitHub enforces CODEOWNERS but nothing
enforces AGENTS.md. Matches the pattern the surrounding bullets
already use for codecov.yml, SECURITY.md, CONTRIBUTING.md, etc.
Aliserag added a commit to onflow/flow-ai-tools that referenced this pull request Apr 23, 2026
Per review feedback on the sibling atree PR (onflow/atree#658),
reference the CODEOWNERS file rather than listing its members
inline. The hard-coded list would silently go stale when the team
rotates reviewers, since GitHub enforces CODEOWNERS but nothing
enforces AGENTS.md. Matches the pattern the surrounding bullets
already use for codecov.yml, SECURITY.md, CONTRIBUTING.md, etc.
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.

2 participants