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/subproviders | |
| parent | 674e56cea69fe96ddd0071d3c4c5b5ea8ae299bf (diff) | |
| download | dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.gz dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.bz2 dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.lz dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.xz dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.zst dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.zip | |
Improve contributing section of all packages so they include building entire monorepo on first contribution
Diffstat (limited to 'packages/subproviders')
| -rw-r--r-- | packages/subproviders/README.md | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index ac92b89d2..60fd41fc6 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -22,11 +22,11 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ## 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: @@ -34,17 +34,33 @@ If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: yarn config set workspaces-experimental true ``` +Then install dependencies + ```bash 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 |