Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

TenzDelek
Copy link
Contributor

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

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npm run format to ensure the code follows the style guide.
  • I have run npm run test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

@TenzDelek TenzDelek requested a review from a team as a code owner November 13, 2024 03:56
Copy link

vercel bot commented Nov 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Nov 13, 2024 4:38am

Copy link
Member

@mikeesto mikeesto left a 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?

@TenzDelek
Copy link
Contributor Author

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 😃

Copy link
Member

@mikeesto mikeesto left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

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]: Inconsistency in development start command between Contributing Guide and README
5 participants