Skip to content

Conversation

@Priyans00
Copy link

Proposed changes (including videos or screenshots)

Clarifies that the repository uses Yarn 4 (Berry), recommends Corepack for Yarn
management, adds a short Windows note about long path support, and documents that
peer dependency warnings during install are expected.

This is a documentation-only change intended to improve contributor onboarding.

Issue(s)

Closes #1812

Further comments

@changeset-bot
Copy link

changeset-bot bot commented Jan 2, 2026

⚠️ No Changeset found

Latest commit: 3a64e2b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLAassistant commented Jan 2, 2026

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Collaborator

@tassoevan tassoevan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README file is autogenerated. You need to change the generation script to allow a fixed section of text like this.

@Priyans00
Copy link
Author

Thanks for the clarification
I’ll update the generation script to include a fixed Contributing section with the Yarn 4 Corepack guidance, and regenerate the readme accordingly

@Priyans00 Priyans00 requested a review from tassoevan January 21, 2026 09:06
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.

docs: clarify Yarn 4 (Berry) and Corepack requirements for local development

3 participants