Adopt AGENTS.md convention for maintainer docs#280
Open
kamran-rapidfireAI wants to merge 1 commit into
Open
Conversation
10 tasks
Move maintainer guidance into AGENTS.md files (at the repo root and under
rapidfireai/fit/{backend,db,dispatcher,ml,utils} and rapidfireai/frontend) and
leave each CLAUDE.md as a thin `@AGENTS.md` pointer, so every agent that follows
the AGENTS.md convention reads the same project rules as Claude Code.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
kamran-rapidfireAI
force-pushed
the
docs/agents-md-convention
branch
from
654f446 to
cf8c90e
Compare
This was referenced Jun 26, 2026
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.
What
Adopt the
AGENTS.mdconvention for maintainer docs. The guidance previously held in eachCLAUDE.mdnow lives in a siblingAGENTS.md, and everyCLAUDE.mdis reduced to a thin@AGENTS.mdpointer.This lets every agent that follows the
AGENTS.mdconvention (Cursor, Codex, GitHub Copilot, Windsurf, Aider, Junie, …) read the same project rules Claude Code already reads, with no duplicated content to keep in sync.Files (14)
AGENTS.md+CLAUDE.mdAGENTS.md+CLAUDE.mdunderrapidfireai/fit/{backend,db,dispatcher,ml,utils}andrapidfireai/frontend13 of the 14 files are migrated verbatim. The only authored change is the root
AGENTS.md"Keepingdocs/AGENTS.mdin sync" section: it is generalized to category-level triggers with no fixed section-number references, so it stays accurate whether the end-user guide ships install-only or also covers code integration.Dependencies
Independent of the related docs PRs (#281, #282) — disjoint file sets, mergeable in any order.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only refactor with no runtime, API, or dependency changes; risk is limited to agent tooling loading the correct guide files.
Overview
Introduces
AGENTS.mdas the canonical maintainer guide for AI coding agents (Cursor, Codex, Copilot, Windsurf, etc.), not only Claude Code. Maintainer guidance that lived in sevenCLAUDE.mdfiles is moved into siblingAGENTS.mdfiles at the repo root and underrapidfireai/fit/{backend,db,dispatcher,ml,utils}andrapidfireai/frontend.Each
CLAUDE.mdis reduced to a single@AGENTS.mdpointer so Claude Code still auto-loads rules without duplicating content. The only substantive new authoring (vs verbatim migration) is the root **Keeping docs/AGENTS.mdin sync** section: category-level triggers for when to update the end-userdocs/AGENTS.md, explicit decoupling of volatile install details toREADME.md`, and a grep-based drift check.The frontend maintainer doc is reframed for all agents (not “Claude Code only”) and adds Playwright MCP setup notes for Cursor, Codex, Copilot, and Windsurf in addition to Claude Code.
Reviewed by Cursor Bugbot for commit cf8c90e. Bugbot is set up for automated code reviews on this repo. Configure here.