-
-
Notifications
You must be signed in to change notification settings - Fork 603
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
docs: fix the setup workflow #591 #597
Conversation
Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon. |
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.
A minor comment and it looks good to me 🙏
CONTRIBUTING.md
Outdated
@@ -34,6 +34,7 @@ In case you are suggesting a new feature, we will match your idea with our curre | |||
|
|||
### Setup with npm | |||
* Install the dependencies: `npm install` | |||
* Bootstrap the packages:`npx lerna bootstrap` |
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.
No need to use npx, regular npm is sufficient
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.
You mean npm lerna bootstrap
? It doesn't seem to work for me. I use [email protected]
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.
Npm run bootstrap is the command you’re looking for I assume
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.
Yes, you're right. My initial thought was to keep consistent between yarn and npm.
@EvsChen Thanks for your update. I labeled the Pull Request so reviewers will review it again. @ev1stensberg Please review the new changes. |
CONTRIBUTING.md
Outdated
@@ -42,6 +43,7 @@ In case you are suggesting a new feature, we will match your idea with our curre | |||
|
|||
```bash | |||
yarn install | |||
yarn lerna bootstrap |
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.
Yarn bootstrap
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.
Its yarn bootstrap that needs change, keep it as the old commit, but change the lerna instruction to be correct
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.
Keep the install commands and it looks good
Sorry I'm a little confused. I think it's either |
You need to install deps first. Add those lines and youre good. Npm install and yarn |
But there is a |
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.
Lgtm :shipit
Thanks for your patience. Sorry I didn't make my point clear. |
What kind of change does this PR introduce?
Improve docs
Summary
As mentioned in #591 , the setup guidance is not clear enough for newcomers who setup the directory for the first time. The bootstrap command is necessary.
Does this PR introduce a breaking change?
No