Skip to content

Add AGENTS.md agent guidance - #250

Open
tashian wants to merge 3 commits into
mainfrom
carl/eff-787-claude-md
Open

Add AGENTS.md agent guidance#250
tashian wants to merge 3 commits into
mainfrom
carl/eff-787-claude-md

Conversation

@tashian

@tashian tashian commented Sep 10, 2026

Copy link
Copy Markdown
Member

Name of feature:

Add a AGENTS.md with guidance for coding agents working in this repository.

Pain or issue this feature alleviates:

The file describes what the module is and who consumes it, the verified make/go commands and what CI runs, the package layout, how command.Register wires STEP_* env vars and defaults.json, and the conventions to follow (urfave/cli v1, pkg/errors, testify). It contains no build or code changes.

Supporting links/other PRs/issues:

.claude/CLAUDE.md is a one-line @../AGENTS.md import so Claude Code loads the same file.

Tracks EFF-787.

🤖 Generated with Claude Code

https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV

Document the module's purpose, verified Makefile/CI commands, package
layout, how command registration wires STEP_* env vars and defaults.json,
and the conventions (urfave/cli v1, pkg/errors, testify) contributors and
coding agents should follow.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
AGENTS.md is the vendor-neutral file read by other coding agents. Claude
Code does not read it natively, so CLAUDE.md becomes a one-line
@AGENTS.md import that loads the same content.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
@tashian tashian changed the title Add CLAUDE.md agent guidance Add AGENTS.md agent guidance Sep 10, 2026
@tashian
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants