Skip to content

docs: Add CLAUDE.md file#206

Draft
ankurdotb wants to merge 3 commits intoprereleasefrom
claude-md
Draft

docs: Add CLAUDE.md file#206
ankurdotb wants to merge 3 commits intoprereleasefrom
claude-md

Conversation

@ankurdotb
Copy link
Copy Markdown
Collaborator

Summary

Initialise CLAUDE.md file

Scope

  • @zama-fhe/sdk
  • @zama-fhe/react-sdk
  • @zama-fhe/test-components
  • @zama-fhe/test-nextjs
  • @zama-fhe/test-vite
  • CI/workflows
  • Docs

Validation

N/A

Related

N/A

Demo (if possible)

N/A

@cla-bot cla-bot Bot added the cla-signed label Apr 7, 2026
@ankurdotb ankurdotb marked this pull request as draft April 7, 2026 09:50
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 7, 2026

Public API Changes

✅ No public API changes detected.

@ankurdotb
Copy link
Copy Markdown
Collaborator Author

@enitrat I can already guess that this is bad. Am I correct in understanding the pnpm commands are basically worthless? Already plan to change/improve this.

Do you have any specific tips, besides NOT putting in too much stuff?

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 7, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 92.29% (🎯 80%) 3055 / 3310
🔵 Statements 92.39% 3133 / 3391
🔵 Functions 92.01% (🎯 80%) 957 / 1040
🔵 Branches 85.18% (🎯 80%) 1271 / 1492
File CoverageNo changed files found.
Generated in workflow #1415 for commit 276aaa1 by the Vitest Coverage Report Action

@ghermet
Copy link
Copy Markdown
Contributor

ghermet commented Apr 7, 2026

@enitrat I can already guess that this is bad. Am I correct in understanding the pnpm commands are basically worthless? Already plan to change/improve this.

Do you have any specific tips, besides NOT putting in too much stuff?

This is Boris Cherny's claude.md, the aim is to provide guidelines on specific topics. For us a guideline would be the North star of the SDK so that claude sticks to it in documentation, naming conventions, etc...

ankurdotb and others added 2 commits April 7, 2026 18:25
Replace reference manual (commands, directory listings, code style rules)
with product vision, operation flow map, naming conventions, and design
decisions that Claude cannot infer from config files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment thread CLAUDE.md

Semantic-release automates versioning. Both packages are versioned in lockstep. `main` publishes to npm `latest`; `prerelease` branch publishes to npm `alpha`. CI gates: Vitest + Playwright must pass before publish.
- **TanStack `useQueries` wrapper is mandatory** in react-sdk. Never import `useQueries` directly from `@tanstack/react-query` — use the wrapper in `packages/react-sdk/src/utils/query.ts` which injects the custom `queryKeyHashFn`. An ast-grep rule enforces this.
- **Build order matters.** `@zama-fhe/sdk` must build before `@zama-fhe/react-sdk`. `pnpm build` handles this correctly.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd suspect that Claude could infer this information as @zama-fhe/sdk is a dependency of @zama-fhe/react-sdk

@enitrat
Copy link
Copy Markdown
Contributor

enitrat commented Apr 10, 2026

good reference to keep in mind: https://www.aihero.dev/a-complete-guide-to-agents-md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants