diff options
Diffstat (limited to 'packages/sol-cov')
| -rw-r--r-- | packages/sol-cov/README.md | 44 |
1 files changed, 41 insertions, 3 deletions
diff --git a/packages/sol-cov/README.md b/packages/sol-cov/README.md index 5591b9731..130db039e 100644 --- a/packages/sol-cov/README.md +++ b/packages/sol-cov/README.md @@ -24,11 +24,11 @@ var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider; ## Contributing -We strongly encourage the community to help us make improvements. To report bugs within this package, please create an issue in this repository. +We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. +Please read our [contribution guidelines](./CONTRIBUTING.md) before getting started. -### Install Dependencies +### Install dependencies If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: @@ -42,8 +42,46 @@ Then install dependencies yarn install ``` +### Build + +If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory: + +```bash +yarn lerna:rebuild +``` + +Or continuously rebuild on change: + +```bash +yarn dev +``` + +You can also build this specific package by running the following from within its directory: + +```bash +yarn build +``` + +or continuously rebuild on change: + +```bash +yarn build:watch +``` + +### Clean + +```bash +yarn clean +``` + ### Lint ```bash yarn lint ``` + +### Run Tests + +```bash +yarn test +``` |