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/types/README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) (limited to 'packages/types') diff --git a/packages/types/README.md b/packages/types/README.md index b971eaee7..b51cf3f3a 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -24,13 +24,13 @@ import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types'; ## Contributing -We strongly recommend that the community help us make improvements and determine the future direction of the protocol. 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 e`nabled (Yarn < v1.0) - enable them: +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: ```bash yarn config set workspaces-experimental true @@ -44,16 +44,36 @@ 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 ``` +### Clean + +```bash +yarn clean +``` + ### Lint ```bash -- cgit From 29d38593d6313412fb820f2311bb9accb66e6684 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Thu, 5 Apr 2018 10:01:41 +0900 Subject: Fix contributing links --- packages/types/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/types') diff --git a/packages/types/README.md b/packages/types/README.md index b51cf3f3a..665701ea4 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -26,7 +26,7 @@ import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types'; 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 -- cgit