chore: add AI agent configuration and ubiquitous language glossary#7091
chore: add AI agent configuration and ubiquitous language glossary#7091diegolmello wants to merge 3 commits intodevelopfrom
Conversation
…be839075aba5e/ubiquitous-language/SKILL.md
WalkthroughTwo new documentation files were added to the repository: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
CLAUDE.md (1)
7-12: Add a “last verified” stamp for version-sensitive guidance.This section will age quickly (React/RN/Expo/Node/Yarn). Add a small “Last verified on” note to reduce stale operational guidance.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` around lines 7 - 12, Add a “Last verified on” date stamp to the version summary block so readers know when the platform versions were confirmed; update the CLAUDE.md section that lists React/React Native/Expo/TypeScript/Node/Yarn (the version-sensitive paragraph starting with "Rocket.Chat React Native mobile client...") to include a short line like "Last verified on: YYYY-MM-DD" immediately after that paragraph and keep it updated when versions change.AGENTS.md (1)
1-1: Make the pointer explicit and clickable.Using only
CLAUDE.mdis easy to miss in rendered docs. Prefer a short heading + markdown link so agents and humans immediately understand intent.Suggested doc tweak
-CLAUDE.md +# AI Agent Instructions + +See [CLAUDE.md](./CLAUDE.md) for repository guidance and working conventions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 1, Replace the bare filename "CLAUDE.md" with a short heading and an explicit clickable Markdown link so it's obvious and discoverable; update AGENTS.md to include a heading like "Claude agent" (or similar) followed by a markdown link [CLAUDE.md](CLAUDE.md) that points to the document, ensuring the intent is explicit and immediately visible to readers and agents.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@UBIQUITOUS_LANGUAGE.md`:
- Line 126: The phrase "zero or one **Agents**" in the Omnichannel Room
definition is ambiguous; update the sentence referencing "Omnichannel Room",
"Visitor", and the "Served By" relationship to use singular and clarify that it
denotes the current agent assignment (which can change over time), e.g. reword
to something like: "An Omnichannel Room connects exactly one Visitor with at
most one Agent via the Served By relationship; the Agent is the current
assignment and may change over time." Ensure the terms "Omnichannel Room",
"Visitor", "Agent", and "Served By" remain bolded and consistent with the
UBIQUITOUS_LANGUAGE.md style.
---
Nitpick comments:
In `@AGENTS.md`:
- Line 1: Replace the bare filename "CLAUDE.md" with a short heading and an
explicit clickable Markdown link so it's obvious and discoverable; update
AGENTS.md to include a heading like "Claude agent" (or similar) followed by a
markdown link [CLAUDE.md](CLAUDE.md) that points to the document, ensuring the
intent is explicit and immediately visible to readers and agents.
In `@CLAUDE.md`:
- Around line 7-12: Add a “Last verified on” date stamp to the version summary
block so readers know when the platform versions were confirmed; update the
CLAUDE.md section that lists React/React Native/Expo/TypeScript/Node/Yarn (the
version-sensitive paragraph starting with "Rocket.Chat React Native mobile
client...") to include a short line like "Last verified on: YYYY-MM-DD"
immediately after that paragraph and keep it updated when versions change.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d31ade04-2209-49e8-a231-1482dbbf9eb0
📒 Files selected for processing (3)
AGENTS.mdCLAUDE.mdUBIQUITOUS_LANGUAGE.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: ESLint and Test / run-eslint-and-test
🔇 Additional comments (2)
UBIQUITOUS_LANGUAGE.md (1)
1-145: Great glossary structure and coverage.The terminology tables, relationships, and ambiguity notes are clear and practical for cross-team/domain alignment.
CLAUDE.md (1)
13-93: Solid onboarding and architecture guidance.Commands, system boundaries, and entry points are well organized and actionable.
Proposed changes
CLAUDE.mdwith project guidance for Claude Code (architecture, commands, code style, entry points)AGENTS.mdas a pointer for AI agentsUBIQUITOUS_LANGUAGE.mdwith a DDD-style glossary of canonical terms used across the codebaseIssue(s)
How to test or reproduce
Screenshots
Types of changes
Checklist
Further comments
Summary by CodeRabbit