Skip to content

Add AGENTS.md and update CLAUDE.md with project documentation#1908

Open
UdaraWickramarathne wants to merge 1 commit intowso2:PEfrom
UdaraWickramarathne:PE
Open

Add AGENTS.md and update CLAUDE.md with project documentation#1908
UdaraWickramarathne wants to merge 1 commit intowso2:PEfrom
UdaraWickramarathne:PE

Conversation

@UdaraWickramarathne
Copy link
Copy Markdown

Documentation Setup

Adds standard AI agent documentation files to improve developer onboarding
and assist AI-assisted development workflows.

Changes

  • AGENTS.md – Comprehensive project documentation including architecture
    overview, module layout, build/test commands, request flow, database setup,
    testing patterns, CI/CD pipeline, and PR conventions.
  • CLAUDE.md – Updated to reference AGENTS.md as the primary
    documentation source for this repository.

Why

These files provide structured context for both human developers and AI coding
assistants, reducing onboarding time and ensuring consistent development practices.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

Warning

Rate limit exceeded

@UdaraWickramarathne has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 9 minutes and 37 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 9 minutes and 37 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3d9a8753-7719-4d76-9bc5-f5c887a9ea6e

📥 Commits

Reviewing files that changed from the base of the PR and between 6b25f09 and a37e43a.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md
✨ 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 and usage tips.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

2 participants