SDKS-5133: Add AI Agent Context Files to Repository by SteinGabriel · Pull Request #708 · ForgeRock/ping-javascript-sdk

SteinGabriel · 2026-06-26T15:32:30Z

Summary

https://pingidentity.atlassian.net/browse/SDKS-5133

Adds a canonical AGENTS.md with full architectural context for AI coding agents (Claude Code, GitHub Copilot, Gemini, Cursor,
etc.), plus provider-specific redirect files. Previously, developers maintained their own AI context files locally,
uncommitted — this standardizes and shares that context across the team.

Changes

Root

AGENTS.md (new) — canonical agent context: project overview, monorepo layer diagram, build/lint/test commands,
file-naming-as-architecture conventions, dependency direction rules, and SDK architectural patterns
GEMINI.md (new) — @./AGENTS.md import directive (Gemini CLI injects content at parse time)

`.github`

copilot-instructions.md (new) — prose redirect to ../AGENTS.md with explicit read instruction (Copilot has no
file-include syntax)

`.gitignore` / `package.json`

Removed GEMINI.md / **/GEMINI.md ignore entries so the redirect can be committed
Removed -e "!**/GEMINI.md" guard from the clean script (file is now tracked; guard is no longer needed)

Tests

No runtime behavior — all changes are markdown/config files
Structural assertions verified manually: each provider file resolves to AGENTS.md, CLAUDE.local.md is git-ignored,
GEMINI.md is NOT ignored
pnpm lint and pnpm build pass with no new errors

How to test

1. Verify file structure

cat AGENTS.md        # non-empty, has ## Architecture Overview section
cat CLAUDE.md        # should be: @AGENTS.md + disclaimer note
cat GEMINI.md        # should be: @./AGENTS.md + disclaimer note
cat .github/copilot-instructions.md  # prose redirect + read instruction

2. Verify gitignore state

git check-ignore -v GEMINI.md      # should return nothing (not ignored)
git check-ignore -v CLAUDE.local.md  # should return .gitignore or .git/info/exclude (ignored)

3. Verify clean script

cat package.json | grep '"clean"'
# should NOT contain -e "!**/GEMINI.md"

chore(context): add canonical AGENTS.md with SDK architectural context chore(context): convert CLAUDE.md to @AGENTS.md import chore(context): add GEMINI.md redirect and un-ignore from gitignore chore(context): convert copilot-instructions.md to AGENTS.md redirect chore(context): move CLAUDE.local.md exclusion from .gitignore to .git/info/exclude chore(context): sharpen effects.ts vs micros.ts distinction in AGENTS.md chore(context): enumerate all redirect files in AGENTS.md note chore(context): use @./AGENTS.md import in GEMINI.md for proper context injection chore(context): document Copilot include limitation and add read instruction chore(context): remove inaccurate "one-line" from redirect notes

changeset-bot · 2026-06-26T15:32:34Z

⚠️ No Changeset found

Latest commit: dec43c4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

nx-cloud · 2026-06-26T15:33:17Z

View your CI Pipeline Execution ↗ for commit dec43c4

Command	Status	Duration	Result
`nx run-many -t build --no-agents`	✅ Succeeded	1m 42s	View ↗
`nx affected -t build lint test typecheck e2e-ci`	✅ Succeeded	<1s	View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗

☁️ Nx Cloud last updated this comment at 2026-06-26 15:35:31 UTC

coderabbitai · 2026-06-26T15:33:24Z

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7bea2f1e-9907-41b8-a5ec-a5427dd713ce

📥 Commits

Reviewing files that changed from the base of the PR and between ae71c21 and dec43c4.

📒 Files selected for processing (6)

.github/copilot-instructions.md
.gitignore
AGENTS.md
CLAUDE.md
GEMINI.md
package.json

 ____________________________________________________
< Your logging is so chatty it needs a podcast deal. >
 ----------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch SDKS-5133

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.}

pkg-pr-new · 2026-06-26T15:35:45Z

Open in StackBlitz

@forgerock/davinci-client

pnpm add https://pkg.pr.new/@forgerock/davinci-client@708

@forgerock/device-client

pnpm add https://pkg.pr.new/@forgerock/device-client@708

@forgerock/journey-client

pnpm add https://pkg.pr.new/@forgerock/journey-client@708

@forgerock/oidc-client

pnpm add https://pkg.pr.new/@forgerock/oidc-client@708

@forgerock/protect

pnpm add https://pkg.pr.new/@forgerock/protect@708

@forgerock/sdk-types

pnpm add https://pkg.pr.new/@forgerock/sdk-types@708

@forgerock/sdk-utilities

pnpm add https://pkg.pr.new/@forgerock/sdk-utilities@708

@forgerock/iframe-manager

pnpm add https://pkg.pr.new/@forgerock/iframe-manager@708

@forgerock/sdk-logger

pnpm add https://pkg.pr.new/@forgerock/sdk-logger@708

@forgerock/sdk-oidc

pnpm add https://pkg.pr.new/@forgerock/sdk-oidc@708

@forgerock/sdk-request-middleware

pnpm add https://pkg.pr.new/@forgerock/sdk-request-middleware@708

@forgerock/storage

pnpm add https://pkg.pr.new/@forgerock/storage@708

commit: dec43c4

github-actions · 2026-06-26T15:36:20Z

Deployed 84de09f to https://ForgeRock.github.io/ping-javascript-sdk/pr-708/84de09f9e4e024b50b7097ac38f266f1f99650af branch gh-pages in ForgeRock/ping-javascript-sdk

github-actions · 2026-06-26T15:36:29Z

📦 Bundle Size Analysis

🚨 Significant Changes

🔻 @forgerock/device-client - 0.0 KB (-10.0 KB, -100.0%)
🔻 @forgerock/journey-client - 0.0 KB (-92.6 KB, -100.0%)

📊 Minor Changes

📉 @forgerock/device-client - 10.0 KB (-0.0 KB)

➖ No Changes

➖ @forgerock/oidc-client - 35.3 KB
➖ @forgerock/sdk-types - 9.1 KB
➖ @forgerock/davinci-client - 53.8 KB
➖ @forgerock/sdk-utilities - 18.6 KB
➖ @forgerock/journey-client - 92.6 KB
➖ @forgerock/protect - 144.6 KB
➖ @forgerock/iframe-manager - 3.2 KB
➖ @forgerock/sdk-logger - 1.6 KB
➖ @forgerock/storage - 1.5 KB
➖ @forgerock/sdk-request-middleware - 4.6 KB
➖ @forgerock/sdk-oidc - 5.7 KB

14 packages analyzed • Baseline from latest main build

Legend

🆕 New package
🔺 Size increased
🔻 Size decreased
➖ No change

ℹ️ How bundle sizes are calculated

Current Size: Total gzipped size of all files in the package's dist directory
Baseline: Comparison against the latest build from the main branch
Files included: All build outputs except source maps and TypeScript build cache
Exclusions: .map, .tsbuildinfo, and .d.ts.map files

_{🔄 Updated automatically on each push to this PR}

SteinGabriel requested review from ancheetah, cerebrl, ryanbas21 and vatsalparikh June 26, 2026 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SDKS-5133: Add AI Agent Context Files to Repository#708

SDKS-5133: Add AI Agent Context Files to Repository#708
SteinGabriel wants to merge 1 commit into
mainfrom
SDKS-5133

SteinGabriel commented Jun 26, 2026

Uh oh!

changeset-bot Bot commented Jun 26, 2026

Uh oh!

nx-cloud Bot commented Jun 26, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Jun 26, 2026

Uh oh!

github-actions Bot commented Jun 26, 2026

Uh oh!

github-actions Bot commented Jun 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

SteinGabriel commented Jun 26, 2026

Summary

Changes

Root

.github

.gitignore / package.json

Tests

How to test

1. Verify file structure

Uh oh!

changeset-bot Bot commented Jun 26, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Jun 26, 2026

Uh oh!

github-actions Bot commented Jun 26, 2026

Uh oh!

github-actions Bot commented Jun 26, 2026

📦 Bundle Size Analysis

📦 Bundle Size Analysis

🚨 Significant Changes

Legend

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

1 participant

`.github`

`.gitignore` / `package.json`

nx-cloud Bot commented Jun 26, 2026 •

edited

Loading

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading