Skip to content

Commit

Permalink
Mention the use of ocamlformat in the contributing guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
voodoos committed Sep 24, 2024
1 parent 406c764 commit 7c5da09
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,9 @@ issue has not already been submitted.

### Styleguides

As of today, Merlin's codebase does not use a code formatter. When contributing
code to an existing module, one should adopt the style of the surrounding code.
Please keep lines under 80 characters.

We plan to move the codebase to ocamlformat in a near future.
Merlin uses ocamlformat. When contributing code, please always format it by
running `dune fmt` before submitting a PR. The required version of ocamlformat
can be found in the `.ocamlformat` configuration file.

Changes unrelated to the issue addressed by a PR should be made in a separate
PR. Additionally, formatting changes in parts of the code not concerned by a
Expand Down

0 comments on commit 7c5da09

Please sign in to comment.