SDKS-5034 Add AGENTS.md as canonical AI agent context#165
Merged
Conversation
Adds AGENTS.md as the single source of truth for AI agent guidance in this repo. Absorbs the still-valid content from GEMINI.md (platform, toolchain, external deps, CI/CD) and removes the existing CLAUDE.md content, replacing it with a one-line redirect. Removes AGENTS.md and CLAUDE.md from .gitignore so they are shared across all contributors. Phases: - Phase 1: create AGENTS.md from CLAUDE.md + GEMINI.md; update .gitignore - Phase 2: replace CLAUDE.md with `See AGENTS.md.` Refs: SDKS-5034
rodrigoareis
requested review from
george-bafaloukas-forgerock,
spetrov and
vahancouver
June 11, 2026 19:45
rodrigoareis
changed the title
george-bafaloukas-forgerock
approved these changes
Jun 15, 2026
george-bafaloukas-forgerock
left a comment
george-bafaloukas-forgerock
left a comment
Contributor
There was a problem hiding this comment.
LGTM
vahancouver
requested changes
Jun 19, 2026
| @@ -0,0 +1 @@ | |||
| See AGENTS.md. | |||
Contributor
There was a problem hiding this comment.
you can double check, but apparently this wouldn't work. you need to use the file reference like this
@AGENTS.md
| PingOath ← PingTamperDetector | ||
| PingPush ← PingNetwork, PingTamperDetector | ||
| PingAuthMigration ← PingOath, PingPush | ||
| ``` |
Contributor
There was a problem hiding this comment.
PingDeviceClient ←PingCommons , PingNetwork is missing
Contributor
There was a problem hiding this comment.
Sorry I think I misspoke. I meant PingDeviceClient also depends on PingNetwork. that part is missing
| @@ -0,0 +1,153 @@ | |||
| # AGENTS.md | |||
|
|
|||
| This file provides guidance to AI coding agents (Claude Code, Cursor, GitHub Copilot, Gemini, etc.) when working with code in this repository. It follows the open AGENTS.md convention. | |||
Contributor
There was a problem hiding this comment.
Should we mention Gemini here if we are still ignoring GEMINI.md file?
Contributor
Author
There was a problem hiding this comment.
I think it's ok to mention it in general, even if we are not including a GEMINI.md file
Signed-off-by: Rodrigo Reis <rodrigo.reis@forgerock.com>
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
3 participants
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.
JIRA Ticket
SDKS-5034 "[iOS] Add context to the SDK repository"
Description
Add the open-source, tool-agnostic
AGENTS.mdstandard at the repo root and ensureCLAUDE.mdwith a one-line redirect file** (See AGENTS.md.) rather than a symlink. This avoids symlink portability issues (Windowscore.symlinks=false) while keeping maintenance burden at zero — the redirect only needs updating ifAGENTS.mdis renamed. Claude Code reads bothAGENTS.mdandCLAUDE.mdnatively, so it picks up the full content fromAGENTS.mddirectly.Checklist: