From bb41fab5e583100c7d06da8b033df422969a012f Mon Sep 17 00:00:00 2001 From: Valentin Gatien-Baron Date: Mon, 10 Jun 2024 21:37:45 +0200 Subject: [PATCH] update stale bits of CONTRIBUTING.md Signed-off-by: Valentin Gatien-Baron --- CONTRIBUTING.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a60ef6abd..7d766ea02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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