aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-05 08:57:21 +0800
committerFabio Berger <me@fabioberger.com>2018-04-05 08:57:21 +0800
commitd76bc18bb7ccaa18f31df6e48722502e21610bdf (patch)
treefdd1f63efb8fe50797f5ebb788ab6b35cbd41f30 /packages/react-docs
parent674e56cea69fe96ddd0071d3c4c5b5ea8ae299bf (diff)
downloaddexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar
dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.gz
dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.bz2
dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.lz
dexon-0x-contracts-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.xz
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/react-docs')
-rw-r--r--packages/react-docs/README.md32
1 files changed, 29 insertions, 3 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
index 9be370f10..479a24cc3 100644
--- a/packages/react-docs/README.md
+++ b/packages/react-docs/README.md
@@ -51,11 +51,11 @@ Feel free to contribute to these improvements!
## 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.
+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:
@@ -71,10 +71,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 continuously rebuild on change:
+
+```bash
+yarn build:watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
### Lint
```bash