Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update stale bits of CONTRIBUTING.md #499

Merged
merged 1 commit into from
Jun 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading