docs: state the principles in CLAUDE.md and shorten REVIEW.md - #2938
Conversation
CLAUDE.md is now eight one-sentence principles that the SDK is built and reviewed by, and REVIEW.md points at them. Style rules are gone from both files: Prettier, ESLint and the compiler own style. The architecture walkthrough is removed because it restated the code and had gone stale. CONTRIBUTING.md gains a short "Good to know" list under Development with the repository details that neither the code nor the tools tell you.
|
@modelcontextprotocol/client
@modelcontextprotocol/codemod
@modelcontextprotocol/core
@modelcontextprotocol/server
@modelcontextprotocol/server-legacy
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
There was a problem hiding this comment.
Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.
Beyond the inline findings, I checked that every path the new text points at resolves — test/e2e/requirements.ts, packages/codemod/src/migrations/v1-to-v2/mappings/, and the per-package test/ layout all exist — and that packages/client and packages/server still carry barrelClean tests, so the browser-safe root-entry rule remains machine-checked for those two packages even with the written rule gone.
Extended reasoning...
Docs-only change rewriting CLAUDE.md to eight principles, cutting REVIEW.md to a pointer, and adding a short list to CONTRIBUTING.md; no code or security-sensitive surface. Not approved because the inline findings concern deleted guidance (the auto-maintained Recurring Catches section and the runtime-neutral export rule) and the removal of a review-convention file is a policy decision a maintainer should weigh.
The barrelClean tests cover client and server and a short list of Node-only modules, so the rule is worth stating once.
Requested by Felix Weinberger · Slack thread
CLAUDE.mdis now eight principles and one sentence saying that style belongs to the formatter and linter;REVIEW.mdis one sentence pointing at those principles plus the style line;CONTRIBUTING.mdgains a short "Good to know" list under Development.The previous files carried style rules the formatter and linter contradict and an architecture walkthrough that had gone stale, so automated review kept quoting them. Principles over process: one sentence each, nothing a linter can check.
No package changes, so no changeset.
🤖 Generated with Claude Code
https://claude.ai/code/session_012VRbFCp41otcScXE1YY3es
Generated by Claude Code