docs: align CLAUDE.md, CONTRIBUTING.md, and CHANGELOG with pnpm migration#233
Merged
Conversation
Refs #232 - Replace npm with pnpm in CLAUDE.md dev/release workflow snippets (install, build, test, link, lint, format, release). - Add a Security entry to CHANGELOG noting the 24-hour package quarantine (`minimumReleaseAge: 1440`) introduced with the pnpm migration to reduce supply-chain attack risk.
Refs #232 - Replace npm with pnpm across dev setup, testing, and release sections - Add a short note on the 24h minimumReleaseAge supply-chain quarantine so contributors aren't surprised when a fresh dependency bump waits - Fix stale references: keytar → @napi-rs/keyring, and the outdated `mcpc <url> session @name` CLI syntax in the session-lifecycle example - Trim the architecture overview section: the protocol/IPC/lifecycle detail duplicated CLAUDE.md and was already rotting. Replaced with a high-level module map plus a pointer to CLAUDE.md for the deep dive.
jancurn
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #232 (pnpm migration). Doc-only updates so the contributor workflow we describe matches the
packageManager: pnpm@10.33.4setup actually in the repo.CLAUDE.md— replacenpm install/npm run build/npm test/npm link/npm run lint/npm run releasesnippets with theirpnpmequivalents. References tonpm publish(the registry action, not a script) are kept as-is.CONTRIBUTING.md— same npm → pnpm swap across dev setup, testing, and release sections. Also:minimumReleaseAgequarantine, so contributors aren't surprised when a fresh dependency bump appears "stuck".keytar→@napi-rs/keyring, and the outdatedmcpc <url> session @namesyntax →mcpc connect <url> @name.CLAUDE.mdand was already rotting. Replaced with a high-level module map plus a pointer toCLAUDE.mdfor the deep dive. Net: 244 → 134 lines.CHANGELOG.md— add aSecurityentry under[Unreleased]calling out the 24-hour package quarantine (minimumReleaseAge: 1440) and clarifying that installing@apify/mcpcfrom npm is unaffected (end users can still use npm/pnpm/bun).Refs #232.
Test plan
CLAUDE.mdandCONTRIBUTING.mdno longer referencenpm run …for dev scripts (onlynpm publishfor the registry action remains)CONTRIBUTING.mdno longer referenceskeytaror the oldsession @nameCLI syntaxCHANGELOG.md[Unreleased] → Securityentry reads clearly for end usersGenerated by Claude Code