Skip to content

docs: state the principles in CLAUDE.md and shorten REVIEW.md - #2938

Merged
felixweinberger merged 2 commits into
mainfrom
docs/principles-claude-review-md
Oct 2, 2026
Merged

felixweinberger merged 2 commits into
mainfrom
docs/principles-claude-review-md

Conversation

@claude

@claude claude Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Requested by Felix Weinberger · Slack thread

CLAUDE.md is now eight principles and one sentence saying that style belongs to the formatter and linter; REVIEW.md is one sentence pointing at those principles plus the style line; CONTRIBUTING.md gains 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

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.
@claude
claude Bot requested a review from a team as a code owner October 2, 2026 18:03
@changeset-bot

changeset-bot Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: eb7d661

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@modelcontextprotocol/client

npm i https://pkg.pr.new/@modelcontextprotocol/client@2938

@modelcontextprotocol/codemod

npm i https://pkg.pr.new/@modelcontextprotocol/codemod@2938

@modelcontextprotocol/core

npm i https://pkg.pr.new/@modelcontextprotocol/core@2938

@modelcontextprotocol/server

npm i https://pkg.pr.new/@modelcontextprotocol/server@2938

@modelcontextprotocol/server-legacy

npm i https://pkg.pr.new/@modelcontextprotocol/server-legacy@2938

@modelcontextprotocol/express

npm i https://pkg.pr.new/@modelcontextprotocol/express@2938

@modelcontextprotocol/fastify

npm i https://pkg.pr.new/@modelcontextprotocol/fastify@2938

@modelcontextprotocol/hono

npm i https://pkg.pr.new/@modelcontextprotocol/hono@2938

@modelcontextprotocol/node

npm i https://pkg.pr.new/@modelcontextprotocol/node@2938

commit: eb7d661

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

Comment thread REVIEW.md
Comment thread CLAUDE.md
The barrelClean tests cover client and server and a short list of Node-only modules, so the rule is worth stating once.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Code review found no issues

No high-confidence issues detected in this change.

@felixweinberger
felixweinberger merged commit 818f782 into main Oct 2, 2026
25 checks passed
@felixweinberger
felixweinberger deleted the docs/principles-claude-review-md branch October 2, 2026 18:34
@claude claude Bot added the v2 Ideas, requests and plans for v2 of the SDK which will incorporate major changes and fixes label Oct 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v2 Ideas, requests and plans for v2 of the SDK which will incorporate major changes and fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant