Add AGENTS.md agent guidance - #335
Open
tashian wants to merge 2 commits into
Open
Conversation
Adds vendor-neutral guidance for AI coding agents: verified build, test, lint and run commands, an annotated layout of cmd/, commands/, sds/ and logging/, the SDS request and renewal flow, and the CLI/error/logging/ testing conventions in use. CLAUDE.md is a one-line import of AGENTS.md so Claude Code reads the same file. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
github-actions
Bot
added
the
needs triage
tashian
enabled auto-merge (squash)
September 10, 2026 16:21
Per review: keep the repo root to AGENTS.md and put the Claude Code import stub under .claude/, importing @../AGENTS.md. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Name of feature:
AGENTS.mdguidance for AI coding agents, plus aCLAUDE.mdimport stub.Pain or issue this feature alleviates:
Coding agents working in this repo had nothing to orient them.
AGENTS.mddocuments the verified build, test, lint and run commands, an annotated layout ofcmd/,commands/,sds/andlogging/, the SDS request and renewal flow, and the CLI, error-handling, logging and testing conventions in use. It also flags the Makefile targets that no longer work (integration, and the README'smake docker)..claude/CLAUDE.mdis a one-line@../AGENTS.mdimport so Claude Code picks up the same file.Is there documentation on how to use this feature? If so, where?
The file is the documentation; it is read automatically by agents that support
AGENTS.mdorCLAUDE.md.Supporting links/other PRs/issues:
Tracks EFF-787.
馃 Generated with Claude Code
https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV