aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-cov/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-09 13:34:36 +0800
committerFabio Berger <me@fabioberger.com>2018-04-09 13:34:36 +0800
commite05b55d4a5698d3e936e7164ed69d9417d12cd12 (patch)
tree1f9be2d21d21cc915687f3606b2dad9e8a4add8e /packages/sol-cov/README.md
parent6f24337a5309bc4b06d0a91eac3af7566bde5754 (diff)
parent073bf738ddb271b6b4158798baf4cac3cb0608e9 (diff)
downloaddexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar.gz
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar.bz2
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar.lz
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar.xz
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.tar.zst
dexon-sol-tools-e05b55d4a5698d3e936e7164ed69d9417d12cd12.zip
merge development
Diffstat (limited to 'packages/sol-cov/README.md')
-rw-r--r--packages/sol-cov/README.md42
1 files changed, 40 insertions, 2 deletions
diff --git a/packages/sol-cov/README.md b/packages/sol-cov/README.md
index 5591b9731..8cc7dca6c 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.
-### 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
+```