aboutsummaryrefslogtreecommitdiffstats
path: root/packages/abi-gen/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/abi-gen/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/abi-gen/README.md')
-rw-r--r--packages/abi-gen/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md
index 899b4845e..301bd709f 100644
--- a/packages/abi-gen/README.md
+++ b/packages/abi-gen/README.md
@@ -57,3 +57,61 @@ See the [type definition](https://github.com/0xProject/0x-monorepo/tree/developm
## Output files
Output files will be generated within an output folder with names converted to camel case and taken from abi file names. If you already have some files in that folder they will be overwritten.
+
+## Contributing
+
+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
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+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 continuously rebuild on change:
+
+```bash
+yarn build:watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```