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

Added note to SETUP.md #3220

Closed
wants to merge 1 commit into from
Closed

Added note to SETUP.md #3220

wants to merge 1 commit into from

Conversation

eesazahed
Copy link

Describe the changes you have made in this PR

I added a note to the top of SETUP.md. The note informs the reader that while the tutorial uses Yarn as the package manager, they can substitute it with other preferred managers like npm or pnpm, and should also update the package.json file accordingly.

Type of change

  • docs: Documentation update

How has this been tested?

Tested locally with successful results.

Checklist

  • Self-review of changed code
  • Manual testing
  • Added automated tests where applicable
  • [ x] Update Docs & Guides
  • For UI-related changes
  • Darkmode
  • Responsive layout

@reneaaron
Copy link
Contributor

I am not sure this PR is actually solving a problem:

If you are using this repository for the first time (and you have no knowledge about other package managers) you should probably stick with yarn. If you are already using other package managers I suppose you should also know how to use your preferred package manager instead.

Just be sure to make the same changes in your local package.json file while in development.

I also don't understand this hint. Yarn & npm both use package.json?

@eesazahed
Copy link
Author

So the problem I am trying to solve is that some new/inexperienced devs might not use yarn. They might only have npm installed. So I added that note at the top.

I also don't understand this hint. Yarn & npm both use package.json?

In package.json, you can see "build": "yarn build:chrome && yarn build:firefox && yarn build:opera",

The note is to remind the reader that they can change it to "build": "npm build:chrome && npm build:firefox && npm build:opera" in addition to all of the other use cases of yarn in the file.

@reneaaron
Copy link
Contributor

I think unexperienced devs should just install yarn instead of manually editing the package.json file:

npm install --global yarn

@eesazahed
Copy link
Author

I get what you're saying. Final decision is up to you

@pavanjoshi914
Copy link
Contributor

I think the current version of documentation is consistent with yarn. and its not a greater side of usecase for anyone to suggest alternate package manager in docs. closing this

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.

3 participants