Improve contributing section of all packages so they include building entire monorepo on first contribution

This commit is contained in:
Fabio Berger
2018-04-05 09:57:21 +09:00
parent 674e56cea6
commit d76bc18bb7
22 changed files with 684 additions and 84 deletions

View File

@@ -16,11 +16,11 @@ This will list out any dependencies that differ in versions between packages.
## 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:
@@ -36,11 +36,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
@@ -57,3 +71,9 @@ yarn clean
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```