Skip to content

Rename CLAUDE.md to AGENTS.md for cross-agent compatibility#7166

Open
NoryGit wants to merge 3 commits into
FAForever:developfrom
NoryGit:agent_instructions
Open

Rename CLAUDE.md to AGENTS.md for cross-agent compatibility#7166
NoryGit wants to merge 3 commits into
FAForever:developfrom
NoryGit:agent_instructions

Conversation

@NoryGit

@NoryGit NoryGit commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Description of the proposed changes

Import AGENTS.md into CLAUDE.md to make the comprehensive UI guidance introduced by @Garanas agent-agnostic, allowing Codex, Cursor, Gemini, etc. to benefit from it too. Going by my testing, Claude's behavior remains unchanged.

Checklist

Summary by CodeRabbit

  • Documentation
    • Updated UI and chat guidance to reference the new AGENTS.md-based convention format (including controller/MVC notes and layout/anchoring guidance).
    • Introduced/rewrote centralized /lua/ui/AGENTS.md with standardized UI construction, reactivity, cleanup, and skinning conventions.
    • Replaced legacy chat CLAUDE.md content with a pointer to the new chat AGENTS.md refactoring guide.
  • Chores
    • Added a changelog snippet noting the CLAUDE.mdAGENTS.md rename.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 17c3a88d-3e5b-4fd9-8931-4b5e71411d51

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2958 and 92a6ce8.

📒 Files selected for processing (4)
  • .claude/skills/add-chat-command/SKILL.md
  • lua/ui/AGENTS.md
  • lua/ui/game/chat/AGENTS.md
  • lua/ui/game/chat/LAYOUT.md
✅ Files skipped from review due to trivial changes (4)
  • .claude/skills/add-chat-command/SKILL.md
  • lua/ui/game/chat/LAYOUT.md
  • lua/ui/AGENTS.md
  • lua/ui/game/chat/AGENTS.md

📝 Walkthrough

Walkthrough

This PR renames CLAUDE.md references to AGENTS.md across /lua/ui, adds new UI and chat AGENTS guidance, replaces the old CLAUDE docs with redirect stubs, and updates related cross-references plus a changelog note.

Changes

AGENTS.md documentation migration

Layer / File(s) Summary
New UI AGENTS.md guide
lua/ui/AGENTS.md
Adds UI conventions for class construction, LazyVar reactivity, cleanup, layout, skinning, component references, debugging, and hot reload.
UI CLAUDE.md replaced with redirect
lua/ui/CLAUDE.md
Replaces the existing UI doc content with a single @AGENTS.md directive.
New chat AGENTS.md MVC guide
lua/ui/game/chat/AGENTS.md
Adds chat MVC guidance covering models, controllers, view rules, UI element mapping, standalone entry points, and prohibited patterns.
Chat CLAUDE.md replaced with redirect
lua/ui/game/chat/CLAUDE.md
Replaces the chat refactoring guide content with a single @AGENTS.md directive.
Cross-reference updates
.claude/skills/add-chat-command/SKILL.md, lua/ui/game/chat/LAYOUT.md, changelog/snippets/other.7166.md
Updates documentation links from CLAUDE.md to AGENTS.md and adds the rename note to the changelog.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: area: ui, ui: chat window

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: renaming CLAUDE.md to AGENTS.md for agent compatibility.
Description check ✅ Passed It includes the main description and checklist, but omits the testing and additional context sections from the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.claude/skills/add-chat-command/SKILL.md:
- Line 77: The cross-reference in the skill doc is using the wrong casing, which
breaks the link on case-sensitive filesystems. Update the `AGENTS.MD` reference
in `SKILL.md` to `AGENTS.md` so the existing link keeps resolving after the
rename; this is the only change needed and should be made in the line that
mentions the `AGENTS.MD` cross-reference.

In `@lua/ui/AGENTS.md`:
- Line 3: The cross-references in this AGENTS doc use the wrong filename casing,
so update every occurrence of AGENTS.MD to AGENTS.md throughout the document,
including the links that point to the folder-specific guidance referenced from
the opening paragraph and the later cross-references. Keep the wording the same
and only normalize the filename casing so all links resolve correctly on
case-sensitive renderers.

In `@lua/ui/game/chat/AGENTS.md`:
- Line 5: The chat AGENTS doc has broken references because it links to the
renamed AGENTS.md file using the wrong casing. Update the hrefs in this document
so the links point to the correctly cased AGENTS.md path everywhere, including
the project-wide UI rules reference at the top.

In `@lua/ui/game/chat/LAYOUT.md`:
- Line 3: Update the markdown cross-reference in the chat layout documentation
so it points to the renamed AGENTS.md target with the correct casing. Fix the
link text and any related references in LAYOUT.md to use the same filename
casing as the actual file, keeping the rest of the guidance intact.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 551d0f74-b5c4-4d6e-95c7-f08e2ea6713b

📥 Commits

Reviewing files that changed from the base of the PR and between 7b9f49c and 8ef2958.

📒 Files selected for processing (7)
  • .claude/skills/add-chat-command/SKILL.md
  • changelog/snippets/other.7166.md
  • lua/ui/AGENTS.md
  • lua/ui/CLAUDE.md
  • lua/ui/game/chat/AGENTS.md
  • lua/ui/game/chat/CLAUDE.md
  • lua/ui/game/chat/LAYOUT.md

Comment thread .claude/skills/add-chat-command/SKILL.md Outdated
Comment thread lua/ui/AGENTS.md Outdated
Comment thread lua/ui/game/chat/AGENTS.md Outdated
Comment thread lua/ui/game/chat/LAYOUT.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant