docs(claude): refresh .claude/ rules and add testing guide - #385
Merged
MatiasOS merged 2 commits intoMay 12, 2026
Merged
Conversation
Adds .claude/rules/testing.md documenting the Vitest + Playwright testing model — unit test config, the two Playwright projects (chromium / mocked), the e2e/tests/ tree organisation, hermetic vs live trade-offs, and CI workflow mapping. Updates CLAUDE.md to reference testing.md in the modular instructions index, patterns.md to add a "Testing Patterns" section pointing at mocked vs live conventions, and commands.md with the focused per-suite e2e runners and the mocked Playwright project command.
CLAUDE.md: pin the Bun version (1.1.0) and add quick-reference rows for `check`, unit/e2e test runners, and `npm run dev`. architecture.md: enumerate every adapter with chain IDs (split out BNB/Polygon/Solana, list Arbitrum/OP-Stack testnets), point at the adapters factory in source, and document the worker/ companion sub-project (Hono RPC proxy, Cloudflare/Vercel/Deno deployment). commands.md: document `build:development`, plain `build`, `preview`, `check`, `audit` (with audit.sh note about the temporary lockfile), and `publish:dist`.
|
🚀 Preview: https://pr-385--openscan.netlify.app |
AugustoL
approved these changes
May 12, 2026
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.
Description
Refreshes the
.claude/rules directory to reflect the current state of the codebase. Adds a newtesting.mddocumenting the Vitest + Playwright model (projects, suites, mocking, CI mapping), expands the architecture and commands docs with details that have drifted (adapter coverage, theworker/companion sub-project, additional npm scripts), and brings the top-levelCLAUDE.mdquick-reference in line.Related Issue
N/A — documentation maintenance.
Type of Change
Changes Made
.claude/rules/testing.md(new)chromiumfor live RPC,mockedfor hermetic specs undere2e/tests/shared/mocked/).e2e/tests/directory tree by chain family (bitcoin/,eth-mainnet/,evm-networks/,shared/,solana/,testnets/)..claude/rules/patterns.mdshared/mocked/; chain-specific live specs go undereth-mainnet/,evm-networks/, etc..claude/rules/architecture.mdBNBAdapter(56/97),PolygonAdapter(137/80002), andSolanaAdapter, and listing Arbitrum/OP-Stack testnets.src/services/adapters/adaptersFactory.tsand documents the three factory entry points (createAdapter,createBitcoinAdapter,createSolanaAdapter).worker/" section describing the Hono-based RPC proxy, its multi-platform deployment (Cloudflare Workers / Vercel Edge / Deno Deploy), and the redundancy/failover behaviour from the frontend..claude/rules/commands.mdbuild:development, plainbuild,preview,check,audit(with a note onaudit.shgenerating a temporary lockfile because the repo uses Bun), andpublish:dist.test:e2e:eth-mainnet,test:e2e:evm-networks), the--project=mockedcommand, and a cross-link to the newtesting.md..claude/CLAUDE.mdnpm runcommands work because they invokepackage.jsonscripts (bun runis equivalent).check, unit/e2e test runners, andnpm run dev.testing.mdin the modular instructions index.Screenshots (if applicable)
N/A — documentation-only change.
Checklist
npm run format:fixandnpm run lint:fix(no-op for.mdfiles — Biome is scoped tosrc/**.ts/.tsx/.json)npm run typecheckwith no errors (no source changes)npm run test:run(no source changes)Additional Notes
devper the patch-release workflow.