[codex] align contributor setup docs and pnpm config#1937
Merged
richiemcilroy merged 1 commit intoJun 19, 2026
Conversation
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
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
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
package.jsontopnpm-workspace.yamlso the pinned pnpm version no longer warns that the config is ignored.CONTRIBUTING.mdto match the repo's pinned pnpm version.pnpm env-setupbeforepnpm cap-setup.Why
While testing the contributor setup path from a fresh clone, pnpm printed a warning on every command because
package.json#pnpm.peerDependencyRulesis no longer read by current pnpm. The contributor guide also had stale setup instructions that disagreed with README andpackageManager.Verification
pnpm --versionpnpm install --lockfile-onlypnpm installpnpm exec biome check --write CONTRIBUTING.md package.jsongit diff --checkpnpm install,pnpm env-setup,pnpm cap-setupcd apps/web && pnpm dev, thencurl -I http://127.0.0.1:3000returnedHTTP/1.1 200 OKNote: I did not fully verify
pnpm dev:webin 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
peerDependencyRulesfrompackage.json(ignored by pnpm v9+) topnpm-workspace.yaml, and updatesCONTRIBUTING.mdto reflect the current pinned pnpm version and the correct setup order.pnpm-workspace.yaml: AddspeerDependencyRules.allowedVersionsfornext-auth>next, which is the canonical location for this setting in pnpm v9+; the equivalent block is removed frompackage.json.CONTRIBUTING.md: Fixes a "Runing" typo, updates the required pnpm version from8.10.5+to10.5.2to matchpackageManager, and movespnpm env-setupbeforepnpm cap-setupto 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
Reviews (1): Last reviewed commit: "chore: align contributor setup docs" | Re-trigger Greptile