aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contracts/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-06 06:18:36 +0800
committerFabio Berger <me@fabioberger.com>2017-12-06 06:18:36 +0800
commit08168c6e7d52711aeb46e27444ba26970e16e244 (patch)
tree40a006de279221009d0ee05d73bfbb74f0a9ea91 /packages/contracts/README.md
parentb5030df4e3afe17b4e652b438d655edda79c5f54 (diff)
parent4441d76725af4e83f90eeb373983b600b6903e8e (diff)
downloaddexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.gz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.bz2
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.lz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.xz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.zst
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.zip
Merge branch 'development' into feature/addSubproviders
* development: (50 commits) Add PR number to changelog Address feedback Add requestId to subscription messages and update json-schemas Remove isomorphic-fetch types from contracts package Update README Regenerate files Make it private Change package name Update README Make fileExtension configurable Rename abi-gen to typed-contracts Add docs for typed-contracts Remove TODOs Introduce separate ContextData type and rework it Check ABI is defined Introduce a const for 'contract.mustache' Improve error message Reuse util Fix a typo Introduce a const for 'function' ... # Conflicts: # yarn.lock
Diffstat (limited to 'packages/contracts/README.md')
-rw-r--r--packages/contracts/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/packages/contracts/README.md b/packages/contracts/README.md
new file mode 100644
index 000000000..57c75cb85
--- /dev/null
+++ b/packages/contracts/README.md
@@ -0,0 +1,51 @@
+Contracts
+-----
+
+## Useful 0x Wiki Articles
+
+* [Architecture](https://0xproject.com/wiki#Architecture)
+* [Contract Interactions](https://0xproject.com/wiki#Contract-Interactions)
+* [Contract deployed addresses](https://0xproject.com/wiki#Deployed-Addresses)
+* [0x Protocol Message Format](https://0xproject.com/wiki#Message-Format)
+* [Bug Bounty Program](https://0xproject.com/wiki#Bug-Bounty)
+
+## Setup
+
+### Installing Dependencies
+
+Install [Node](https://nodejs.org/en/download/releases/)
+
+Install [yarn](https://yarnpkg.com/lang/en/docs/install/) in order to install the project dependencies more deterministically.
+
+Install project dependencies:
+
+```
+yarn
+```
+
+### Running Tests
+
+Start Testrpc
+
+```
+yarn testrpc
+```
+
+Run tests
+
+```
+yarn test
+```
+
+## Contributing
+
+0x protocol is intended to serve as an open technical standard for EVM blockchains and we strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within the 0x smart contracts or unit tests, please create an issue in this repository.
+
+### ZEIPs
+Significant changes to 0x protocol's smart contracts, architecture, message format or functionality should be proposed in the [0x Improvement Proposals (ZEIPs)](https://github.com/0xProject/ZEIPs) repository. Follow the contribution guidelines provided therein.
+
+### Coding conventions
+
+We use a custom set of [TSLint](https://palantir.github.io/tslint/) rules to enforce our coding conventions.
+
+In order to see style violation errors, install a tslinter for your text editor. e.g Atom's [atom-typescript](https://atom.io/packages/atom-typescript).