From 2cb8b766b40cd555ac58b46f7de630422498867d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dragi=C5=A1a=20Spasojevi=C4=87?= Date: Mon, 19 Sep 2022 14:09:25 +0200 Subject: [PATCH] docs: add development tools section (#434) * docs: add development tools section * add .editorconfig * add yarn --- .editorconfig | 5 +++++ readme.md | 13 +++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..0b3779e53d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,5 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true diff --git a/readme.md b/readme.md index 11b2f720a4..0214954766 100644 --- a/readme.md +++ b/readme.md @@ -52,6 +52,19 @@ Read more about the setup [here](/packages/arb-token-bridge-ui/tests/e2e/README.md). +### Development Tools + +We use a couple of tools to automate things (e.g. code formatting), maintain consistency and reduce noise for code reviews. For the optimal development experience, install the following tools: + +- [Yarn](https://classic.yarnpkg.com) - Package manager + - Find Yarn install guide for your system [here](https://classic.yarnpkg.com/en/docs/install) +- [Prettier](https://prettier.io) - Automatic code formatting + - Find Prettier integration for your code editor [here](https://prettier.io/docs/en/editors.html) +- [EditorConfig](https://editorconfig.org) - Automatic file formatting + - Find EditorConfig integration for your code editor [here](https://editorconfig.org/#download) +- [ESLint](https://eslint.org) - Static analysis for JavaScript + - Find ESLint integration for your code editor [here](https://eslint.org/docs/latest/user-guide/integrations#editors) + ### Deposit Lifecycle A Deposit is tracked via a single `Transaction` entry (in the `useTransactions` hook) which represents its initiated L1 transaction; its L2 status is tracked via the `L1ToL2MessageData` field.