Skip to content

[codex] align contributor setup docs and pnpm config#1937

Merged
richiemcilroy merged 1 commit into
CapSoftware:mainfrom
archit-goyal:codex/align-contributor-setup
Jun 19, 2026
Merged

[codex] align contributor setup docs and pnpm config#1937
richiemcilroy merged 1 commit into
CapSoftware:mainfrom
archit-goyal:codex/align-contributor-setup

Conversation

@archit-goyal

@archit-goyal archit-goyal commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Move pnpm peer dependency rules from package.json to pnpm-workspace.yaml so the pinned pnpm version no longer warns that the config is ignored.
  • Update CONTRIBUTING.md to match the repo's pinned pnpm version.
  • Align the CONTRIBUTING setup order with README by running pnpm env-setup before pnpm cap-setup.

Why

While testing the contributor setup path from a fresh clone, pnpm printed a warning on every command because package.json#pnpm.peerDependencyRules is no longer read by current pnpm. The contributor guide also had stale setup instructions that disagreed with README and packageManager.

Verification

  • pnpm --version
  • pnpm install --lockfile-only
  • pnpm install
  • pnpm exec biome check --write CONTRIBUTING.md package.json
  • git diff --check
  • Fresh clone setup: pnpm install, pnpm env-setup, pnpm cap-setup
  • Web-only local app path: cd apps/web && pnpm dev, then curl -I http://127.0.0.1:3000 returned HTTP/1.1 200 OK

Note: I did not fully verify pnpm dev:web in my environment because Docker image pulls for MySQL and MinIO did not complete after several minutes. The web-only documented path above was verified successfully.

Greptile Summary

This PR fixes a pnpm configuration warning by migrating peerDependencyRules from package.json (ignored by pnpm v9+) to pnpm-workspace.yaml, and updates CONTRIBUTING.md to reflect the current pinned pnpm version and the correct setup order.

  • pnpm-workspace.yaml: Adds peerDependencyRules.allowedVersions for next-auth>next, which is the canonical location for this setting in pnpm v9+; the equivalent block is removed from package.json.
  • CONTRIBUTING.md: Fixes a "Runing" typo, updates the required pnpm version from 8.10.5+ to 10.5.2 to match packageManager, and moves pnpm env-setup before pnpm cap-setup to align with README and the actual dependency order.

Confidence Score: 5/5

Safe to merge — all three files contain documentation and config-only changes with no runtime logic affected.

The peerDependencyRules migration is a straightforward move between two config files; pnpm's official docs confirm the setting is valid in pnpm-workspace.yaml. The CONTRIBUTING.md edits correct a stale version pin and a logical ordering mismatch. No source code is touched.

No files require special attention.

Important Files Changed

Filename Overview
CONTRIBUTING.md Fixes "Runing" typo, updates pnpm version to match packageManager field (10.5.2), and reorders setup steps so env-setup runs before cap-setup
package.json Removes pnpm.peerDependencyRules block that pnpm v10 no longer reads from package.json
pnpm-workspace.yaml Adds peerDependencyRules.allowedVersions for next-auth>next — the correct location for this config in pnpm v9+

Reviews (1): Last reviewed commit: "chore: align contributor setup docs" | Re-trigger Greptile

@archit-goyal archit-goyal marked this pull request as ready for review June 19, 2026 09:37
@superagent-security

Copy link
Copy Markdown

Superagent didn't find any vulnerabilities or security issues in this PR.

@richiemcilroy richiemcilroy merged commit 6e6df0b into CapSoftware:main Jun 19, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants