docs: add AGENTS.md for universal AI agent support #30
Conversation
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
- Create AGENTS.md following the agents.md standard - Update CLAUDE.md to reference AGENTS.md as foundation - Remove duplicated content from CLAUDE.md (constraints, basic commands) - AGENTS.md covers: critical constraints, essential commands, repo layout, commit conventions, and common pitfalls (~230 lines) - CLAUDE.md now focuses on extended content: architecture deep-dives, build system internals, code patterns, and troubleshooting This enables Codex, Cursor, Copilot, and other AI tools to work effectively with this repository while Claude Code gets enhanced context from both files. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> Signed-off-by: Jared Scott <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR adopts the agents.md standard (https://agents.md) to provide universal AI agent support while maintaining Claude-specific deep-dive documentation.
- Adds AGENTS.md with essential repository context for all AI coding agents
- Refactors CLAUDE.md to reference AGENTS.md as the foundation layer and focus on Claude-specific extended guidance
- Eliminates content duplication by establishing a clear hierarchy between universal constraints and Claude-specific deep-dives
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | New universal AI agent documentation containing critical constraints, essential commands, repository layout, commit conventions, and common pitfalls for all AI tools |
| CLAUDE.md | Refactored to reference AGENTS.md for basics while retaining Claude-specific architecture deep-dives, build system internals, code patterns, and extended troubleshooting |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
What is in Each File
Why
The agents.md standard (https://agents.md) is emerging as a convention for providing AI coding agents with repository context. By adopting it:
Test plan
Generated with Claude Code