Conversation
Documents system overview, tech stack, directory structure, data flow, dev commands, and coding guardrails for onboarding AI/developers. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a new CLAUDE.md project guide intended to document the library’s purpose, architecture (OIDC session-management iframe pattern), repository layout, dev/test commands, and contribution guardrails for uaa-singular.
Changes:
- Introduces
CLAUDE.mdwith a system/architecture overview and annotated directory structure. - Documents development setup and key npm commands (unit + integration/E2E flow).
- Adds contribution guardrails around build output (
singular/), API surface area, and testing seams.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Bundler:** Webpack 5 (`webpack-cli`) — produces 3 separate bundles from `webpack.config.js` | ||
| - **Polyfill:** `idempotent-babel-polyfill` (injected as a Webpack entry point, not via Babel transpilation config) | ||
| - **Runtime dependency:** `jwt-simple` (declared dependency; JWT decoding is actually hand-rolled in `singular.js` via `atob`) | ||
| - **Unit testing:** Jasmine 5 (`jasmine.json` config, specs in `test/spec/`) |
- Fix stale docs: jwt-simple is unused in src/ (only consumed by the accessTests.js test helper), Jasmine is on 6.x not 5, and the iframe count undercounted the nested authorizeFrame. - Document two things learned while getting the test suite running: chromedriver's pinned version must match the local Chrome major version (don't "fix" this by committing a downgrade), and UAA's test harness moved off the Gradle Cargo plugin to bootRun/kill_uaa.sh. - Note that accessTests.js can be flaky when run alongside identityTests.js in the same Nightwatch invocation. - Ignore CLAUDE.local.md for personal/corporate-environment notes that don't belong in the shared CLAUDE.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Already covered by the user's global excludesFile (*.local.md) — a project-level entry is redundant. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.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
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
CLAUDE.mdreference doc covering system overview, tech stack, annotated directory structure, architecture/data flow (OIDC session-management iframe pattern), dev setup/commands, and coding guardrails.Test plan
src/,package.json,webpack.config.js, and README.🤖 Generated with Claude Code