#773 Added AGENTS.md file

[anushasunkada]

Fixes #773

Summary by CodeRabbit

• Documentation
  • Added developer documentation at the repository root describing AI agent usage, repository/module structure, required Maven/JDK commands, and key architectural/runtime behaviors.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 844035b4-8941-4f34-bb44-81d620bf53a3

📥 Commits

Reviewing files that changed from the base of the PR and between 45cbbfa and ef02d11.

📒 Files selected for processing (1)

• AGENTS.md

---

Walkthrough

A new root-level AGENTS.md file adds repository guidance for AI agents, covering build and test commands, module structure, runtime architecture, configuration loading, synchronization flow, UI integration, and coverage expectations.

Changes

AI Agent Documentation

Layer / File(s)	Summary
Repository guidance added AGENTS.md	New documentation describes Maven commands from registration/, module responsibilities, Spring and Derby behavior, offline sync jobs, packet encryption and upload flow, JavaFX structure, biometric integration, security enforcement, migration behavior, and E2E/Sonar expectations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through docs from root to base,
Found Maven paths and module space.
With sync and UI neatly penned,
AI helpers now know where to գն?

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the change: adding a new AGENTS.md file.
Linked Issues check	✅ Passed	The AGENTS.md addition addresses issue #773 by documenting agent usage, commands, and repository-specific behavior.
Out of Scope Changes check	✅ Passed	The pull request stays within the requested documentation scope and adds no unrelated code changes.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 46-80: Several markdown headings (e.g., "Spring Context
Bootstrap", "Configuration Loading Order", "Offline-First with Sync Jobs",
"Registration Packet Flow", "JavaFX UI Structure", "Biometric Device Integration
(MDM)", "AOP Security", "Local Database") are missing a blank line after the
heading which triggers MD022; insert a single blank line immediately after each
of these heading lines so each heading is separated from the following
paragraph/content (ensure headings retain the leading ### level as shown).

🪄 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: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 31f4c018-9ef0-48e3-a8d2-cdac4828c28a

📥 Commits

Reviewing files that changed from the base of the PR and between ab362c1 and 45cbbfa.

📒 Files selected for processing (1)

• AGENTS.md