Skip to content

Commit

Permalink
Add a note in the readme about git hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
popzxc committed Apr 14, 2020
1 parent 0229e25 commit af56438
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,17 @@ zksync dockerhub-push

# Development

## Committing changes

`zksync` uses pre-commit git hooks for basic code integrity checks. Hooks are set up automatically
within the workspace initialization process. These hooks will not allow to commit the code which does
not pass several checks.

Currently the following criteria are checked:

- Code should always be formatted via `cargo fmt`.
- Dummy Prover should not be staged for commit (see below for the explanation).

## Database migrations

-
Expand Down

0 comments on commit af56438

Please sign in to comment.