Skip to content

Add CLAUDE.md project guide#699

Open
duanemay wants to merge 3 commits into
mainfrom
claude
Open

Add CLAUDE.md project guide#699
duanemay wants to merge 3 commits into
mainfrom
claude

Conversation

@duanemay

Copy link
Copy Markdown
Member

Summary

  • Adds a CLAUDE.md reference 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

  • Documentation-only change; no code paths affected.
  • Reviewed rendered Markdown for accuracy against src/, package.json, webpack.config.js, and README.

🤖 Generated with Claude Code

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>
Copilot AI review requested due to automatic review settings July 10, 2026 21:45

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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.

Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
- **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/`)
Comment thread CLAUDE.md Outdated
duanemay and others added 2 commits July 10, 2026 18:19
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants