chore(docs): add AGENTS.md and CLAUDE.md for AI agent context (SDKS-5134)#54
chore(docs): add AGENTS.md and CLAUDE.md for AI agent context (SDKS-5134)#54pingidentity-gaurav wants to merge 4 commits into
Conversation
…134) Adds the open-standard AGENTS.md at the repo root with comprehensive context for AI coding agents: package table, build/test commands, dual-arch bridge pattern, code standards, releases/Changesets workflow, Lefthook hooks, and E2E testing guidance. Adds CLAUDE.md as a one-line redirect to AGENTS.md. Removes AGENTS.md from .gitignore so it is tracked going forward. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 7 minutes and 13 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthrough
ChangesAI Agent Guidance Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (2)
51-68: 💤 Low valueFix markdown heading hierarchy:
#### Pre-submission checklistshould be###.Line 62 jumps from h2 (
## Design & Quality) directly to h4; markdown convention requires incremental level changes. Change to h3.- Call out potential security risks explicitly if present -#### Pre-submission checklist +### Pre-submission checklist🤖 Prompt for 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. In `@AGENTS.md` around lines 51 - 68, The markdown heading hierarchy in AGENTS.md violates incremental level changes. The "Pre-submission checklist" heading is currently at level 4 (####) but appears directly after a level 2 (##) heading, skipping level 3. Change the "Pre-submission checklist" heading from four hashes (####) to three hashes (###) to establish proper incremental heading progression and follow markdown conventions.
121-127: 💤 Low valueAdd language specifications to fenced code blocks.
Lines 123 and 137 have code blocks representing file layouts but lack a language identifier. Specify
```textfor consistency with markdown linter expectations.### Android layout (`packages/<pkg>/android/src/`) -``` +```text main/ ← *Common.kt — shared implementation newarch/ ← *Module.kt (extends NativeXxxSpec) + *Package.kt oldarch/ ← *ClassicModule.kt (extends ReactContextBaseJavaModule) + *Package.kt -``` +```textAnd similarly for the iOS layout block at line 137:
### iOS layout (`packages/<pkg>/ios/`) -``` +```text *Common.swift / *Impl.swift ← shared Swift implementation RNPing*.mm ← TurboModule (ObjC++): implements getTurboModule: RNPing*Classic.mm ← Classic bridge (ObjC): RCT_EXPORT_MODULE + RCT_EXPORT_METHOD RNPing*.h ← Header for classic bridge linking -``` +```textAlso applies to: 135-142
🤖 Prompt for 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. In `@AGENTS.md` around lines 121 - 127, The fenced code blocks representing the Android layout directory structure and the iOS layout directory structure are missing language identifiers in their opening backticks. Add `text` as the language identifier by changing ``` to ```text for both the Android layout code block (containing main/, newarch/, oldarch/ directory structure) and the iOS layout code block (containing RNPing*.mm, RNPing*Classic.mm, and other file references) to ensure compliance with markdown linter expectations.
🤖 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.
Nitpick comments:
In `@AGENTS.md`:
- Around line 51-68: The markdown heading hierarchy in AGENTS.md violates
incremental level changes. The "Pre-submission checklist" heading is currently
at level 4 (####) but appears directly after a level 2 (##) heading, skipping
level 3. Change the "Pre-submission checklist" heading from four hashes (####)
to three hashes (###) to establish proper incremental heading progression and
follow markdown conventions.
- Around line 121-127: The fenced code blocks representing the Android layout
directory structure and the iOS layout directory structure are missing language
identifiers in their opening backticks. Add `text` as the language identifier by
changing ``` to ```text for both the Android layout code block (containing
main/, newarch/, oldarch/ directory structure) and the iOS layout code block
(containing RNPing*.mm, RNPing*Classic.mm, and other file references) to ensure
compliance with markdown linter expectations.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6c3d7de3-be45-4914-834a-f168ae6e64af
📒 Files selected for processing (3)
.gitignoreAGENTS.mdCLAUDE.md
💤 Files with no reviewable changes (1)
- .gitignore
|
…(SDKS-5134) Address CodeRabbit review comments: - Fix h4 Pre-submission checklist heading to h3 - Add 'text' language identifier to Android and iOS layout code fences Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix packages/core/src/ references → point to native source directories - Add lazy module caching guidance to TypeScript bridge section - Expand Git Safety with a comprehensive forbidden/allowed command list Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove Node <21 upper bound (Node >=20 only) - Replace KDoc @remarks with plain NOTE comment guidance Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2 participants
Summary
AGENTS.mdat the repo root — the open-standard context file for AI coding agents (Claude, Copilot, Gemini, Codex, etc.)CLAUDE.mdas a one-line@AGENTS.mdredirect per the ticket's acceptance criteriaAGENTS.mdfrom.gitignoreso it is tracked going forwardWhat's in AGENTS.md
rn-push)TODO-PARITY)Summary by CodeRabbit
AGENTS.mdis no longer excluded from version control.