docs: add AGENTS.md for universal agent guidelines - #826
Merged
Conversation
- Create AGENTS.md with project guidelines for all AI coding assistants - Simplify CLAUDE.md to reference AGENTS.md - Remove CLAUDE.md from .gitignore so it can be tracked in the repo
Contributor
|
✅ OpenCodeReview: Review complete: 0 finding(s) across 1 selected item(s). |
lizhengfeng101
added a commit
that referenced
this pull request
Aug 10, 2026
…826) - Create AGENTS.md with project guidelines for all AI coding assistants - Simplify CLAUDE.md to reference AGENTS.md - Remove CLAUDE.md from .gitignore so it can be tracked in the repo
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.
Summary
AGENTS.mdwith project guidelines (commit conventions, license headers, code style, testing, README sync) that any coding assistant can follow.CLAUDE.mdto a single pointer toAGENTS.md, avoiding duplication.CLAUDE.mdfrom.gitignoreso it is tracked in the repository.Motivation
As more contributors use various coding assistants (Cursor, Windsurf, Copilot, etc.), a single
AGENTS.mdprovides one source of truth for all tools, whileCLAUDE.mdremains as a lightweight redirect for Claude Code specifically.