From d76bc18bb7ccaa18f31df6e48722502e21610bdf Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
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/testnet-faucets/README.md | 52 ++++++++++++++++++++++++++++++--------
 1 file changed, 42 insertions(+), 10 deletions(-)

(limited to 'packages/testnet-faucets/README.md')

diff --git a/packages/testnet-faucets/README.md b/packages/testnet-faucets/README.md
index 2f6ae347f..0ae1667a3 100644
--- a/packages/testnet-faucets/README.md
+++ b/packages/testnet-faucets/README.md
@@ -4,15 +4,15 @@ This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZR
 
 ## Installation
 
-This is a private package and therefore is not published to npm. In order to build and run this package locally, see the [Install Dependencies](#Install-Dependencies) section and onwards below.
+This is a private package and therefore is not published to npm. In order to build and run this package locally, see the contributing instructions below.
 
 ## 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 enabled (Yarn < v1.0) - enable them:
 
@@ -26,6 +26,44 @@ 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
+```
+
 ### Start
 
 Set the following environment variables:
@@ -125,9 +163,3 @@ docker run -d \
 -e INFURA_API_KEY=$INFURA_API_KEY \
 testnet-faucets
 ```
-
-### Lint
-
-```bash
-yarn lint
-```
-- 
cgit v1.2.3