SDKS-5133: Add AI Agent Context Files to Repository#590
Open
SteinGabriel wants to merge 1 commit into
Open
Conversation
chore(context): convert CLAUDE.md to @AGENTS.md import chore(context): add GEMINI.md redirect to AGENTS.md chore(context): convert copilot-instructions.md to AGENTS.md redirect chore(context): fix redirect files and gitignore for forgerock repo chore(context): fix AGENTS.md note and token-vault dir tree
|
|
View your CI Pipeline Execution ↗ for commit fafe475
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗ ☁️ Nx Cloud last updated this comment at |
commit: |
SteinGabriel
requested review from
ancheetah,
cerebrl,
ryanbas21 and
vatsalparikh
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
https://pingidentity.atlassian.net/browse/SDKS-5133
Adds a canonical
AGENTS.mdto theforgerock-javascript-sdkrepository with full project overview, monorepo architecture,build/test/lint commands, file-naming conventions, and SDK architectural patterns. Provider-specific files (
CLAUDE.md,GEMINI.md,.github/copilot-instructions.md) are thin redirects toAGENTS.md— single source of truth, no content drift.Changes
Root
AGENTS.md(new) — canonical agent context: project overview, module structure (javascript-sdk,ping-protect,token-vault), e2elayout, key directory tree, internal file conventions (suffix-as-architecture table), and architectural principles
CLAUDE.md(new) —@AGENTS.mdimport (Claude Code injects content at parse time)GEMINI.md(new) —@./AGENTS.mdimport directive (Gemini CLI injects content at parse time).github/copilot-instructions.md(new) — prose redirect + explicit read instruction + limitation note (Copilot has no file-includesyntax)
.gitignore— addsCLAUDE.local.mdto ignore list (personal instructions, local only)Tests
No runtime behavior — these are markdown/config context files with no e2e flow to drive. Validation is structural:
AGENTS.mdexists at root, non-empty, valid markdown headingsCLAUDE.mdcontains exactly the@AGENTS.mdimport lineGEMINI.mdcontains the@./AGENTS.mdimport directive.github/copilot-instructions.mdis a prose redirect to../AGENTS.mdCLAUDE.local.mdis git-ignored (git check-ignore CLAUDE.local.mdexits 0)GEMINI.mdis NOT ignored (git check-ignore GEMINI.mdexits nonzero)pnpm lintandpnpm buildpass with no regressionsHow to test
1. Verify file structure