Adopt AGENTS.md convention for maintainer docs - #280
Merged
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
June 25, 2026 23:29
654f446 to
cf8c90e
Compare
This was referenced Jun 26, 2026
Remove the per-subdirectory CLAUDE.md/AGENTS.md files and reduce root AGENTS.md to a short router: AI coding agents helping a user install or run rapidfireai are pointed to docs/AGENTS.md, and contributors working in the repo are pointed to CONTRIBUTING.md. Root CLAUDE.md stays a thin @AGENTS.md pointer. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
arun-rfai
approved these changes
Jul 4, 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 and agent-instruction routing only; no application code, APIs, or runtime behavior changes.
Overview
Adopts the cross-tool
AGENTS.mdconvention so maintainer guidance is not tied to Claude-onlyCLAUDE.mdfiles.Adds a root
AGENTS.mdrouter that sends agents todocs/AGENTS.mdfor install/run help and toCONTRIBUTING.mdfor repo development. Replaces the large rootCLAUDE.mdwith a one-line@AGENTS.mdpointer.Migrates submodule maintainer docs under
rapidfireai/fit/{backend,db,dispatcher,ml,utils}andrapidfireai/frontend: priorCLAUDE.mdbodies move into siblingAGENTS.mdfiles (verbatim), and eachCLAUDE.mdbecomes a thin@AGENTS.mdreference so Claude Code and other agents read the same rules without duplicated copies.Reviewed by Cursor Bugbot for commit 8eb6f5d. Bugbot is set up for automated code reviews on this repo. Configure here.