Skip to content

chore: add AI agent configuration and ubiquitous language glossary#7091

Open
diegolmello wants to merge 3 commits intodevelopfrom
chore.agents
Open

chore: add AI agent configuration and ubiquitous language glossary#7091
diegolmello wants to merge 3 commits intodevelopfrom
chore.agents

Conversation

@diegolmello
Copy link
Copy Markdown
Member

@diegolmello diegolmello commented Apr 1, 2026

Proposed changes

Issue(s)

How to test or reproduce

Screenshots

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves a current function)
  • New feature (non-breaking change which adds functionality)
  • Documentation update (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • I have added necessary documentation (if applicable)
  • Any dependent changes have been merged and published in downstream modules

Further comments

Summary by CodeRabbit

  • Documentation
    • Added comprehensive developer guidance document with project overview, setup instructions, build commands, code style conventions, and architecture details.
    • Added standardized domain terminology guide defining key concepts to ensure consistent language across the codebase.

@diegolmello diegolmello requested a deployment to approve_e2e_testing April 1, 2026 21:37 — with GitHub Actions Waiting
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

Walkthrough

Two new documentation files were added to the repository: CLAUDE.md providing project overview and development guidance, and UBIQUITOUS_LANGUAGE.md defining standardized domain terminology across the codebase.

Changes

Cohort / File(s) Summary
Repository Documentation
CLAUDE.md, UBIQUITOUS_LANGUAGE.md
Added two documentation files: CLAUDE.md includes project overview, Yarn commands, code style conventions, and architecture overview; UBIQUITOUS_LANGUAGE.md establishes standardized domain terminology with definitions, relationships, and guidance for chat/messaging, omnichannel, encryption, video/voice, server, navigation, notification, and user/role concepts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

type: chore

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: adding AI agent configuration (CLAUDE.md, AGENTS.md) and the ubiquitous language glossary document (UBIQUITOUS_LANGUAGE.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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.md is 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

📥 Commits

Reviewing files that changed from the base of the PR and between 50617cd and d281a8e.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • UBIQUITOUS_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.

@diegolmello diegolmello requested a deployment to experimental_ios_build April 1, 2026 21:40 — with GitHub Actions Waiting
@diegolmello diegolmello requested a deployment to experimental_android_build April 1, 2026 21:40 — with GitHub Actions Waiting
@diegolmello diegolmello requested a deployment to official_ios_build April 1, 2026 21:40 — with GitHub Actions Waiting
@diegolmello diegolmello requested a deployment to official_android_build April 1, 2026 21:40 — with GitHub Actions Waiting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant