From d76bc18bb7ccaa18f31df6e48722502e21610bdf Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Thu, 5 Apr 2018 09:57:21 +0900 Subject: Improve contributing section of all packages so they include building entire monorepo on first contribution --- packages/contracts/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'packages/contracts') 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 -- cgit v1.2.3