Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sripwoud committed Aug 7, 2024
1 parent b59c19c commit adc30e7
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,23 @@ or to automatically format the code:
yarn format:write
```

### Linting

```bash
yarn lint
```

Will lint all the packages with [`solhint`](https://github.com/protofire/solhint)

### Static Analysis

```bash
yarn slither
```

Will perform a static analysis of all the contracts with [`slither`](https://github.com/crytic/slither) to identify potential vulnerabilities.
You'll need to [install slither](https://github.com/crytic/slither?tab=readme-ov-file#how-to-install) beforehand.

### Conventional commits

ZK-Kit uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). A [command line utility](https://github.com/commitizen/cz-cli) to commit using the correct syntax can be used by running:
Expand Down

0 comments on commit adc30e7

Please sign in to comment.