chore(docs): add AGENTS.md and CLAUDE.md for AI agent context (SDKS-5134)#54
Open
pingidentity-gaurav wants to merge 1 commit into
Open
chore(docs): add AGENTS.md and CLAUDE.md for AI agent context (SDKS-5134)#54pingidentity-gaurav wants to merge 1 commit into
pingidentity-gaurav wants to merge 1 commit 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>
Contributor
📝 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}
Contributor
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
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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