aboutsummaryrefslogtreecommitdiffstats
path: root/packages/tslint-config/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-06 14:05:34 +0800
committerGitHub <noreply@github.com>2018-04-06 14:05:34 +0800
commit277e58c2e57489a6ac8e8276fe16ec511d3f01fe (patch)
treeaa89d3af99680afdf4753283abf3336702dd4398 /packages/tslint-config/README.md
parent21dc94b709b9a3dbe292287fb95aacddcf0175f1 (diff)
parent9745dfe2f4f15f0c23c150f3b375ff9ed2ace063 (diff)
downloaddexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.gz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.bz2
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.lz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.xz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.zst
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.zip
Merge pull request #505 from 0xProject/fix/readmeContributingSection
Improve README contributing sections in all packages
Diffstat (limited to 'packages/tslint-config/README.md')
-rw-r--r--packages/tslint-config/README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md
index b517f2d95..d90b3cf73 100644
--- a/packages/tslint-config/README.md
+++ b/packages/tslint-config/README.md
@@ -20,11 +20,11 @@ Add the following to your `tslint.json` file
## Contributing
-We strongly encourage 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.
-### Install Dependencies
+### Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
@@ -40,16 +40,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