fix the inconsistency in Development start command between Contributing Guide and README #7224
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
mikeesto
reviewed
Nov 13, 2024
Member
mikeesto
left a comment
mikeesto
left a comment
There was a problem hiding this comment.
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?
Contributor
Author
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 😃 |
AugustinMauroy
approved these changes
Nov 13, 2024
aymen94
approved these changes
Nov 13, 2024
bmuenzenmeyer
approved these changes
Nov 14, 2024
github-actions
bot
removed
the
github_actions:pull-request
Contributor
|
Lighthouse Results
|
Contributor
Unit Test Coverage Report
Unit Test Report
|
bmuenzenmeyer
pushed a commit
that referenced
this pull request
Nov 21, 2024
…ng Guide and README (#7224) * fix the start dev command * doc changes * revert the contributing md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 formatto ensure the code follows the style guide.npm run testto check if all tests are passing.npx turbo buildto check if the website builds without errors.