-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
fix the inconsistency in Development start command between Contributing Guide and README #7224
base: main
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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 we probably want to keep the command as npm run dev
(since that's the common way of starting the dev process in JS projects) and update the README to match instead?
thank you for pointing that out, I should have take a deeper look at the package.json (where the dev script was implementing the turbo command) which @AugustinMauroy did point out (#7219 (comment)). got confuse a little bit 😃 |
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, thanks
Description
The inconsistency between the Contributing Guide and the README regarding the development start command appears to be a result of the project's migration to Turborepo. To ensure clarity and consistency for contributors, it would be beneficial to align the documentation across all project files.
Related Issues
Fixes #7219
Check List
npm run format
to ensure the code follows the style guide.npm run test
to check if all tests are passing.npx turbo build
to check if the website builds without errors.