Add jq to monorepo dependencies in CONTRIBUTING.md

[geoknee]

Description
Edits to CONTRIBUTING.md:

1. jq is an implicit dependency of the monorepo, without which the smart contract tests will fail to run:
   

   optimism/packages/contracts-bedrock/scripts/SemverLock.s.sol

   Line 38 in ee8e6bb

   commands[2] = "forge config --json | jq -r .out";

2. pnpm clean removes node_modules:
   

   optimism/package.json

   Line 12 in 23dd85a

   "clean": "pnpm recursive run clean; rm -rf node_modules packages/*/node_modules && echo 'Finished cleaning. Run `pnpm install && pnpm build` from root of repo to rebuild the repo.'",

   
   so pnpm install should be run before trying pnpm build.

Tests

I tried to run pnpm test as per existing instructions without jq installed and got lots of output such as:

FAIL. Reason: setup failed: the path ProtocolVersions.sol/ProtocolVersions.json is not allowed to be accessed for read operations

Installing jq fixed the problem.

Additional context

These are just minor tweaks I discovered as a newcomer to the repo.

Metadata

• Fixes #[Link to Issue]

[coderabbitai]

Walkthrough

Walkthrough

The update to the CONTRIBUTING.md document specifies the addition of the jq tool to the list of prerequisites. It also updates the setup and troubleshooting instructions to include the use of pnpm install commands, suggesting changes to the project's dependency management practices.

Changes

File	Change Summary
CONTRIBUTING.md	Added jq as a requirement; inserted pnpm install commands in setup and troubleshooting sections.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.