Skip to content

Commit

Permalink
update stale bits of CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Valentin Gatien-Baron <[email protected]>
  • Loading branch information
v-gb committed Jun 11, 2024
1 parent a0d7c8e commit bb41fab
Showing 1 changed file with 8 additions and 15 deletions.
23 changes: 8 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,14 @@ below for details.

### Developing patches

We ask that patches changing the code respect the overall coding
style. In particular, the code should be indented using
[ocp-indent][ocpi]. Additionally the test suite should pass on the
contributor's machine before a patch is submitted for review.

Note that in addition to the normal dependencies, you need to install
[cinaps][cinaps] in order to modify the code. This is because some
parts of the code are auto-generated and committed in the repository.

So before submitting a PR, make sure to check all the following
points:

- all the modified code is correctly indented according to ocp-indent
- `make` succeeds
- `make test` succeeds
Before submitting a PR, please run `dune build @install @runtest @fmt`
on your machine.

In addition to normal dependencies, you'll need to run something like
`opam install cinaps ocamlformat.0.26.1`, but with the version
specified in [`.ocamlformat`](.ocamlformat). [cinaps][cinaps] is used
to keep up-to-date some parts of the code that are auto-generated and
committed in the repository.

### Submitting patches and code review

Expand Down

0 comments on commit bb41fab

Please sign in to comment.