-
Notifications
You must be signed in to change notification settings - Fork 80
Update README.md #2950
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Update README.md #2950
Conversation
Added an explanation to first time repository setup that would've saved me a little research as a non-lerna-native.
|
|
||
| ## Contributing | ||
|
|
||
| This repository uses lerna as a monorepo, to allow the included packages to depend on each other. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the cross-package linking is a yarn feature and the tooling for publishing is facilitated by lerna, but the boundary is vague in my mind.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And maybe link CONTRIBUTING.md.
|
|
||
| ## Contributing | ||
|
|
||
| This repository uses lerna as a monorepo, to allow the included packages to depend on each other. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And maybe link CONTRIBUTING.md.
kriskowal
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change the commit message to a conventional commit, like:
docs: Add getting started instructions for contributors to README
|
Also, I’m sure it would have helped to have a call-out to https://www.conventionalcommits.org/en/v1.0.0/ in |
Added an explanation to first time repository setup that would've saved me a little research as a non-lerna-native.