diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-04-05 08:57:21 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-04-05 08:57:21 +0800 |
| commit | d76bc18bb7ccaa18f31df6e48722502e21610bdf (patch) | |
| tree | fdd1f63efb8fe50797f5ebb788ab6b35cbd41f30 /packages/contracts | |
| parent | 674e56cea69fe96ddd0071d3c4c5b5ea8ae299bf (diff) | |
| download | dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.gz dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.zst dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.zip | |
Improve contributing section of all packages so they include building entire monorepo on first contribution
Diffstat (limited to 'packages/contracts')
| -rw-r--r-- | packages/contracts/README.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/packages/contracts/README.md b/packages/contracts/README.md index 7628b057b..286ef019c 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -34,11 +34,25 @@ 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 +or continuously rebuild on change: ```bash yarn build:watch |