#10670: Add AGENTS.md for AI coding assistant guidance

[chetankh239]

Addresses mosip/mosip-config#10670 — adds a root AGENTS.md hub plus per-module AGENTS.md guides (auditsweeper, certmanager, databreachdetector), since this repo is a collection of three independent Python-based ops/security tools rather than a single application.

Summary by CodeRabbit

• Documentation
  • Added repository-wide development guidance covering project structure, technology, build and test workflows, configuration, credentials, and contribution practices.
  • Added module-specific guidance for auditing, certificate management, and data-breach detection tools.
  • Documented execution options, configuration requirements, deployment considerations, generated reports, and security constraints.
  • Clarified development rules, known limitations, fallback behavior, and safe handling of sensitive information.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ad73745f-7b0e-4777-a9ea-5bdab7e858a1

📥 Commits

Reviewing files that changed from the base of the PR and between 1532ce1 and 398079f.

📒 Files selected for processing (2)

• AGENTS.md
• databreachdetector/AGENTS.md

---

Walkthrough

Added repository-level and module-level AGENTS.md files. The documentation covers project structure, development workflows, execution paths, configuration fallbacks, known limitations, and credential-handling rules.

Changes

Agent guidance

Layer / File(s)	Summary
Repository-wide development guidance AGENTS.md	Documents module responsibilities, tooling, build and test commands, configuration flows, project layout, development workflows, known limitations, and secret-handling rules.
Module execution and operational guidance auditsweeper/AGENTS.md, certmanager/AGENTS.md, databreachdetector/AGENTS.md	Documents module execution paths, configuration requirements, deployment behavior, generated reports, and credential safety rules.
Data breach detector constraints databreachdetector/AGENTS.md	Documents scan configuration, tuning behavior, existing implementation constraints, and rules against unsupported regex or MinIO changes.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

Guidance blooms across the tree,
Clear commands mark the way to be.
Secrets stay masked,
Old limits stay tasked,
Agents work safely and free.

🚥 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 and concisely describes the main change: adding AGENTS.md guidance files for AI coding assistants.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

🤖 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 `@AGENTS.md`:
- Around line 51-54: Clarify the Build & Test Commands section to distinguish
the absence of a shared product build from the root Maven project. Update the
root-build statement to note that the placeholder Maven project is retained
solely for CI, while preserving the documented root Maven command.
- Around line 84-94: Update the CI/testing guidance in AGENTS.md to describe
both sonar-check.yml and chart-lint-publish.yml as CI quality checks, removing
the claim that sonar-check.yml is the only gate. State the local Helm validation
command directly as helm lint helm/<module>, and remove the contradictory
statement that no local lint command is documented.

In `@databreachdetector/AGENTS.md`:
- Around line 38-42: Update the local report-file handling documented in
AGENTS.md and implemented by databreachdetector.py: restrict access to the
generated PII files, ensure they are not committed or shared, and delete each
file only after its MinIO upload is confirmed. If any files must be retained,
document the approved GDPR/MOSIP retention exception and its duration.

🪄 Autofix

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: ASSERTIVE

Plan: Pro Plus

Run ID: e6033c2e-122c-4038-884a-4e641b9ab37b

📥 Commits

Reviewing files that changed from the base of the PR and between b97b7b2 and 1532ce1.

📒 Files selected for processing (4)

• AGENTS.md
• auditsweeper/AGENTS.md
• certmanager/AGENTS.md
• databreachdetector/AGENTS.md