docs: change npm to yarn

mondaycom · Apr 10, 2024 · 411d579 · 411d579
1 parent 9d48749
commit 411d579
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/packages/core/CONTRIBUTING.md b/packages/core/CONTRIBUTING.md
@@ -8,11 +8,11 @@ This library is open-sourced, and we encourage everyone to use and contribute in
 
 1. Create a fork of this repository
 2. Please use the correct node version it is listed in the `.nvmrc` file (you can use `nvm use` in order to switch to the right node version).
-3. Install dependencies with `npm install` command
+3. Install dependencies with `yarn install` command
 4. Sync from upstream if needed
-5. Run Storybook environment locally with `npm run storybook` command.
-6. Make sure all components behave as expected by running all Jest tests locally with 'npm run test'.
-7. If there are changes in some of the library snapshot tests, make sure all changes are intentional. If they are, update them with 'npm run test:update'.
+5. Run Storybook environment locally with `yarn storybook` command.
+6. Make sure all components behave as expected by running all Jest tests locally with 'yarn test'.
+7. If there are changes in some of the library snapshot tests, make sure all changes are intentional. If they are, update them with 'yarn test:update'.
 8. Commit to your local fork using [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)
 9. Create a PR with title based using [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)
    For example: `feat: add new TextArea component`
@@ -24,7 +24,7 @@ This library is open-sourced, and we encourage everyone to use and contribute in
 
 ### Creating new files in the library
 
-Our code generator, Plop, is designed to simplify the creation of frequently used boilerplate code. To utilize it, execute the command `npm run plop`. If you want to learn more about Plop, you can find additional information [here](https://plopjs.com/).
+Our code generator, Plop, is designed to simplify the creation of frequently used boilerplate code. To utilize it, execute the command `yarn plop`. If you want to learn more about Plop, you can find additional information [here](https://plopjs.com/).
 Currently, our Plop code generator supports the creation of the following:
 
 1. Tests

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -48,7 +48,7 @@ We are using storybook in order to develop the components independently of any c
 run this to build & run the storybook locally:
 
 ```bash
-npm run storybook
+yarn storybook
 ```
 
 the storybook will be served on `http://localhost:7007`

diff --git a/packages/core/TESTING_README.md b/packages/core/TESTING_README.md
@@ -62,7 +62,7 @@ describe("Tipseen tests", () => {
 
 ### Running Vibe tests
 **Snapshot and Behavior Tests:**
-To run all snapshot and behavior tests locally, use the command: `npm run test`.
+To run all snapshot and behavior tests locally, use the command: `yarn test`.
 
 **Local Storybook Interaction Tests:**
 To check interaction tests for a specific story in Storybook:

diff --git a/packages/storybook-blocks/CONTRIBUTING.md b/packages/storybook-blocks/CONTRIBUTING.md
@@ -7,11 +7,11 @@ This library is open-sourced, and we encourage everyone to use and contribute in
 
 1. Create a fork of this repository
 2. Please use the correct node version it is listed in the `.nvmrc` file (you can use `nvm use` in order to switch to the right node version).
-3. Install dependencies with `npm install` command
+3. Install dependencies with `yarn install` command
 4. Sync from upstream if needed
-5. Run Storybook environment locally with `npm run storybook` command.
-6. Make sure all components behave as expected by running all Jest tests locally with 'npm run test'.
-7. If there are changes in some of the library snapshot tests, make sure all changes are intentional. If they are, update them with 'npm run test:update'.
+5. Run Storybook environment locally with `yarn storybook` command.
+6. Make sure all components behave as expected by running all Jest tests locally with 'yarn test'.
+7. If there are changes in some of the library snapshot tests, make sure all changes are intentional. If they are, update them with 'yarn test:update'.
 8. Commit to your local fork using [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)
 9. Create a PR with title based using [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)
    For example: `docs: add <ComponentName> story page`

diff --git a/packages/storybook-blocks/README.md b/packages/storybook-blocks/README.md
@@ -84,7 +84,7 @@ Most of the components have a `className` prop that can be used to style them. T
 To run the storybook locally run this command:
 
 ```
-npm run storybook
+yarn storybook
 ```
 
 the storybook will hosted on http://localhost:6005

diff --git a/packages/style/README.md b/packages/style/README.md
@@ -50,7 +50,7 @@ We maintain a metadata file for each icon, it helps our icon library be more rea
 
 How to add a new icon?
 Add the icon in SVG format under the src/Icons folder (size 20x20)
-then run `npm run generate-meta` and fill in the relevant information (you can add multiple icons and run the command once)
+then run `yarn generate-meta` and fill in the relevant information (you can add multiple icons and run the command once)
 
 ### Icon colors