Skip to content

Commit

Permalink
docs: add development tools section (#434)
Browse files Browse the repository at this point in the history
* docs: add development tools section

* add .editorconfig

* add yarn
  • Loading branch information
spsjvc authored Sep 19, 2022
1 parent 45193f0 commit 2cb8b76
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

1 comment on commit 2cb8b76

@vercel
Copy link

@vercel vercel bot commented on 2cb8b76 Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.