diff options
| author | Alex Browne <stephenalexbrowne@gmail.com> | 2018-12-05 12:04:08 +0800 |
|---|---|---|
| committer | Fred Carlsen <fred@sjelfull.no> | 2018-12-13 01:18:56 +0800 |
| commit | e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8 (patch) | |
| tree | 61a906c2b84406febc142f0575e7f24bfe891a0b /packages/pipeline/README.md | |
| parent | da51f6e56f0a0d90ef0abedc25b163b6445b73bb (diff) | |
| download | dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar.gz dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar.bz2 dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar.lz dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar.xz dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.tar.zst dexon-sol-tools-e1d77d6e101ad1c1eabbecfdc10b10d7ea2f9df8.zip | |
Address PR feedback
Diffstat (limited to 'packages/pipeline/README.md')
| -rw-r--r-- | packages/pipeline/README.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/packages/pipeline/README.md b/packages/pipeline/README.md index 794488cac..0f4abd935 100644 --- a/packages/pipeline/README.md +++ b/packages/pipeline/README.md @@ -150,17 +150,17 @@ set the`ZEROEX_DATA_PIPELINE_DB_URL` environment variable to a valid #### Additional guidelines and tips: -* Table names should be plural and separated by underscores (e.g., +- Table names should be plural and separated by underscores (e.g., `exchange_fill_events`). -* Any table which contains data which comes directly from a third-party source +- Any table which contains data which comes directly from a third-party source should be namespaced in the `raw` PostgreSQL schema. -* Column names in the database should be separated by underscores (e.g., +- Column names in the database should be separated by underscores (e.g., `maker_asset_type`). -* Field names in entity classes (like any other fields in TypeScript) should +- Field names in entity classes (like any other fields in TypeScript) should be camel-cased (e.g., `makerAssetType`). -* All timestamps should be stored as milliseconds since the Unix Epoch. -* Use the `BigNumber` type for TypeScript code which deals with 256-bit +- All timestamps should be stored as milliseconds since the Unix Epoch. +- Use the `BigNumber` type for TypeScript code which deals with 256-bit numbers from smart contracts or for any case where we are dealing with large floating point numbers. -* [TypeORM documentation](http://typeorm.io/#/) is pretty robust and can be a +- [TypeORM documentation](http://typeorm.io/#/) is pretty robust and can be a helpful resource. |