diff options
| author | Emilio Jesus Gallego Arias | 2019-12-08 14:26:27 +0100 |
|---|---|---|
| committer | Emilio Jesus Gallego Arias | 2019-12-13 14:15:36 +0100 |
| commit | 4407f71ee45f98499b7ae8b533614dde5b877795 (patch) | |
| tree | e32a1f524d72200b8e7404a7268cd10003e62688 /CONTRIBUTING.md | |
| parent | 202d2314dbfb6d26e635b962916f0e94958f4297 (diff) | |
[fmt] [dune] Add ocamlformat configuration.
For now we don't enable it in any source file, neither on dune files.
`lint-repository` has been updated so it will check `dune build @fmt`
returns 0.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e26103cedd..1a12360c13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -497,6 +497,11 @@ We have a linter that checks a few different things: your branch with `git rebase --whitespace=fix`. - **All files should end with a single newline**. See the section [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. You may run the linter yourself with `dev/lint-repository.sh`. |
