diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 599289f4..1b8bc5f6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -17,7 +17,7 @@ jobs: uses: actions/setup-node@v3 with: node-version: lts/* - - name: Install NPM Dependencies + - name: Install dependencies run: yarn install --frozen-lockfile - name: Run Tests run: yarn test @@ -31,7 +31,7 @@ jobs: uses: actions/setup-node@v3 with: node-version: lts/* - - name: Install NPM Dependencies - run: npm ci + - name: Install dependencies + run: yarn install --frozen-lockfile - name: Run eslint run: yarn lint diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96c5d9ef..8d61f1a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ git checkout -b 6. Be sure to run the tests and set up the relevant linters to ensure all GitHub checks pass (see GitHub issues: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues for more information). ``` -npm test +yarn test ``` 7. Add and commit your changes, including a comprehensive commit message summarising your changes, then push changes to your fork. (e.g. Fixed formatting issue with ImmutableERC721MintByID.sol) @@ -79,4 +79,5 @@ git push origin 9. We will review the pull requests and request any necessary changes. If all the checks (linting, compilation, tests) pass and everything looks good, your code will be merged into the original repository. Congratulations, and thank you for your contribution! ## Releasing -To release the package to NPM, simply create a new GitHub release and the "Publish to NPM" GitHub action will release it to NPM. \ No newline at end of file + +To release the package to NPM, simply create a new GitHub release and the "Publish to NPM" GitHub action will release it to NPM. diff --git a/README.md b/README.md index cb6a71bd..ffaf003f 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ These contracts are feature-rich and are the recommended standard on Immutable z ### Installation ``` -$ npm install @imtbl/zkevm-contracts +$ yarn install @imtbl/zkevm-contracts ``` ### Usage