diff options
| author | Théo Zimmermann | 2020-04-17 11:39:27 +0200 |
|---|---|---|
| committer | Théo Zimmermann | 2020-04-17 12:43:35 +0200 |
| commit | bdeb34ba6c69cb4dc3dd8cb440020561c5a775ca (patch) | |
| tree | 353af41b0804e7d45bf97329027bfebfcaafdda5 /CONTRIBUTING.md | |
| parent | b543bf9c65c98baf90a605b5545dd6315fd2f261 (diff) | |
Adapt linter documentation to the recent improvements of the pre-commit hook.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9adaf5dc7..201d740073 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -503,9 +503,10 @@ We have a linter that checks a few different things: [Style guide](#style-guide) for additional style recommendations. - **Code is properly formatted**: for some parts of the codebase, formatting will be enforced using the - [`ocamlformat`](https://github.com/ocaml-ppx/ocamlformat) tool. You - can integrate the formatter in your editor of choice (see docs) or - use `dune build @fmt --auto-promote` to fix this kind of errors. + [`ocamlformat`](https://github.com/ocaml-ppx/ocamlformat) tool. + Formatting issues will also be fixed automatically by the pre-commit + hook mentioned above (you may also use `dune build @fmt + --auto-promote` to fix this kind of errors). You may run the linter yourself with `dev/lint-repository.sh`. |