docs: add CLAUDE.md with codebase structure, workflows, and conventions - #19
docs: add CLAUDE.md with codebase structure, workflows, and conventions#19codowave wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a new CLAUDE.md file, which serves as a comprehensive developer guide for Claude Code when working in this repository. It details the repository's dual-purpose structure (a TransformerLens fork containing custom projects for biblical correspondence and research OS), lists relevant setup and testing commands, explains the architecture and key invariants of each project, and outlines CI and formatting conventions. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Summary
Adds a
CLAUDE.mdfile to guide AI assistants working in this repository. No CLAUDE.md, Cursor rules, or Copilot rules existed previously.The file covers:
biblical_correspondence/(FastAPI Swedenborg correspondence dictionary app) andresearch_os/+research/hypotheses/(hypothesis-verification CLI), and that custom-project code/comments/commits are written in Japanese.biblical_correspondence, andpython -m research_os verifyusage. Documents the gotcha that rootpyproject.tomlpytestaddoptsleak into subproject test runs (requires-o addopts=""outside the Poetry env — verified by running the tests).transformer_lens; the biblical_correspondence three-state lookup invariant (found/not_found/unavailable, "Codex P1") andverified: falseindex entry handling; the research_os hypothesis lifecycle (exploration → candidate → verified) and falsification-first verification methodology.https://claude.ai/code/session_01C26qdPwYEYhcsL8Au1AJdA
Generated by Claude Code