Skip to content

docs: clarify yarn classic v1.x is required for contributing#782

Open
0xMayurrr wants to merge 1 commit intoOpenZeppelin:masterfrom
0xMayurrr:docs/clarify-yarn-classic-requirement
Open

docs: clarify yarn classic v1.x is required for contributing#782
0xMayurrr wants to merge 1 commit intoOpenZeppelin:masterfrom
0xMayurrr:docs/clarify-yarn-classic-requirement

Conversation

@0xMayurrr
Copy link
Copy Markdown

Fixes #739

The README's Contributing section did not mention that
Yarn Classic (v1.x) is required. Contributors using
Yarn v2/v3 (Berry) run into setup issues. Added a
prerequisites note to clarify this.

@0xMayurrr 0xMayurrr requested a review from a team as a code owner March 14, 2026 06:12
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 14, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6940790e-cc4e-4a1c-8152-05597aaebe62

📥 Commits

Reviewing files that changed from the base of the PR and between 5eec825 and a477e00.

📒 Files selected for processing (1)
  • README.md

Walkthrough

This pull request adds a prerequisites section under the Contributing documentation to explicitly state that Node.js and Yarn Classic (v1.x) are required, with installation instructions. The addition addresses confusion around yarn version requirements for running project scripts.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added prerequisites note under Contributing section documenting required Node.js and Yarn Classic (v1.x) versions with global yarn install command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding documentation to clarify that Yarn Classic v1.x is required for contributing, which directly aligns with the PR's objective.
Description check ✅ Passed The description clearly explains the change (adding prerequisites note), references the linked issue #739, and provides context about the problem Yarn v2/v3 users face.
Linked Issues check ✅ Passed The PR successfully addresses issue #739 by adding documentation to the README's Contributing section clarifying Yarn Classic v1.x requirement, directly fulfilling the issue's objective.
Out of Scope Changes check ✅ Passed The changes are limited to adding a prerequisites note in the README's Contributing section, staying within scope of the linked issue #739 which requests documentation of Yarn Classic requirement.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@0xMayurrr
Copy link
Copy Markdown
Author

I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement

1 similar comment
@0xMayurrr
Copy link
Copy Markdown
Author

I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement

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.

Document properly that yarn classic is required (v1.X)

1 participant