How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
cube-jsCLAUDE.mdcube-js/cube/CLAUDE.md
lint:js # Fix linting issues yarn lint:fix # Lint package.json files yarn lint:npm ``` ### Testing Commands ```bash # Run tests (most packages have individual test commands) yarn test # Test individual packages
No other project uses it yet
wekanCLAUDE.mdwekan/wekan/CLAUDE.md
participant when no human is behind the change.** One rule, two halves, and the test is simply whether a person made this change or a tool
No other project uses it yet
img2threejsCLAUDE.mdimg2threejs/img2threejs/CLAUDE.md
explicitly planned. - When changing schema, gates, generators, or review behavior, add or update focused tests. - Keep `SKILL.md`, `README.md`, `CHANGELOG.md`, and `ROADMAP.md` consistent when release-facing behavior changes. - Reference the companion
Steady9 mentions in 2 weeks
3 projects use a version of this
bitwardenCLAUDE.mdbitwarden/server/.claude/CLAUDE.md
transit, and in use - **ALWAYS** prioritize cryptographic integrity and data protection - **ALWAYS** add unit tests (with mocking) for any new feature development ## Project Structure - **Source Code**: `/src/` - Services and core
No other project uses it yet
DuarteSantos8Reads credentialsCLAUDE.mdDuarteSantos8/openGym/CLAUDE.md
server (hot reload), proxies /api to :3000 cd frontend && npm install && npm run dev # Tests (Node 22, the version CI and the Dockerfiles use) cd frontend && npm test # vitest
No other project uses it yet
go-playgroundCLAUDE.mdgo-playground/validator/CLAUDE.md
module path ends in `/v10`; changes must preserve v10 API compatibility. Contributions require test coverage (see `.github/CONTRIBUTING.md`). ## Commands ```bash make test # go test -cover -race ./... make lint # installs golangci-lint
No other project uses it yet
teng-linCLAUDE.mdteng-lin/notebooklm-py/CLAUDE.md
Commands See [docs/installation.md](docs/installation.md) for the full installation guide. ```bash # Contributor install (matches CI test jobs): uv sync --frozen --extra browser --extra dev --extra markdown \ --extra mcp --extra server --extra
Steady6 mentions in 2 weeks
No other project uses it yet
datawhalechinaCLAUDE.mddatawhalechina/easy-vibe/CLAUDE.md
making changes: - Preserve the VitePress configuration in `docs/.vitepress/config.mjs` - Maintain sidebar structure consistency in config.mjs - Test locally with `npm run dev` before committing - Check that image links work correctly - Ensure theme
No other project uses it yet
AgriciDanielReads credentialsCLAUDE.mdAgriciDaniel/claude-seo/CLAUDE.md
/scripts/claude-seo" run`; plugin state uses `CLAUDE_PLUGIN_DATA` - Manual Python dependencies install into `~/.claude/skills/seo/.venv/` - Test with `python3 -m pytest tests/` after changes (if applicable) ## Security Rules - **Never commit credentials
No other project uses it yet
apollographqlCLAUDE.mdapollographql/apollo-client/CLAUDE.md
Build the entire project - `npm run build -w codegen` - Build specific workspace (e.g., codegen) ### Testing Commands - `npm test` - Run all tests with Jest - `npm run test:type-benches` - Run type
No other project uses it yet
firecrawlCLAUDE.mdfirecrawl/pdf-inspector/CLAUDE.md
text extraction to structured Markdown. CLI binary: `pdf2md`. Detection binary: `detect-pdf`. ## Build & Test ```bash cargo fmt # format cargo clippy -- -D warnings # lint (enforced, zero warnings) cargo test # unit + integration
No other project uses it yet
elysiajsCLAUDE.mdelysiajs/elysia/CLAUDE.md
Nothing speculative. No features beyond what was asked. No abstractions for single-use code. Test: would a senior engineer say this is overcomplicated? If yes, simplify. ## Rule 3 — Surgical Changes
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/CLAUDE.md
computer-use-demo:local` ### Testing & Code Quality - **Lint**: `ruff check .` - **Format**: `ruff format .` - **Typecheck**: `pyright` - **Run tests**: `pytest` - **Run single test**: `pytest tests/path_to_test.py::test_name -v` ### Code Style - **Python**: snake
Steady5 mentions in 2 weeks
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/managed-agents/assistant-ui/CLAUDE.md
noEmit` - `npm run lint` — eslint (the copy-in `components/` are ignored on purpose) - `npm test` — the reducer's golden-turn test; run it whenever the event mapping changes ## Conventions - Name
Steady5 mentions in 2 weeks
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/managed-agents/copilot-kit-ag-ui/CLAUDE.md
serves `web/dist` if present. - `npm run typecheck` covers both workspaces. There are no tests. Verify changes by running the app. ## Design notes - `package.json` pins one `rxjs` version via `overrides
Steady5 mentions in 2 weeks
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/managed-agents/daily-brief/CLAUDE.md
environment.yaml`'s allowlist does not apply to them. 5. **Keep the deployment paused while testing** (`agents/setup.sh` pauses it on creation; manual runs work while paused). `scripts/reset-state.sh` empties the state store
Steady5 mentions in 2 weeks
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/managed-agents/self-hosted-sandboxes/CLAUDE.md
runbook: setup, deploy, register the `session.status_run_started` webhook in the Console, test. Their environment key and webhook secret go in the provider's own secret store, never
Steady5 mentions in 2 weeks
No other project uses it yet
AnthropicReads credentialsCLAUDE.mdanthropics/claude-quickstarts/managed-agents/sentry-autofix/CLAUDE.md
which the user wants. - **Outcomes**: kick off with `user.define_outcome` and a rubric (new test fails before the fix, whole suite passes after, diff touches only what the root cause
Steady5 mentions in 2 weeks
No other project uses it yet
ahmedkhaleel2004Reads credentialsCLAUDE.mdahmedkhaleel2004/gitdiagram/CLAUDE.md
gate (below) first. Pushes that touch only root `*.md`, `docs/**`, `experiments/**` and a few test tools do not deploy to Cloudflare (`paths-ignore` in that workflow). - **Commit to `main
No other project uses it yet
teambitCLAUDE.mdteambit/bit/CLAUDE.md
Compilation - `bit compile` - Compile all components - `bit watch` - Watch for changes and compile automatically ### Testing **IMPORTANT — prefer unit tests (`.spec.ts`) over e2e tests.** E2e tests are extremely expensive: they dominate
No other project uses it yet
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.
Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.
