Skip to content

Commit

Permalink
Update CONTRIBUTING.md's dev env setup instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Rebours <[email protected]>
  • Loading branch information
NathanReb committed Aug 19, 2024
1 parent 844f87b commit 9b1fa5e
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,30 @@ below for details.

### Developing patches

#### Setting up your dev environment

Before starting development on `ppxlib` you should install ppxlib's
dependencies. If you're doing it for the first time you can create
a local switch with all the right dependencies installed by running:
```
opam switch create ./ --with-test --with-dev-setup
```
or if you want to use a pre-existing switch:
```
opam install ./ppxlib.opam --deps-only --with-test --with-dev-setup
```

Note that the `--with-dev-setup` flag is only available from `opam.2.2.0`.
If you are running an older opam and do not wish to update it, you will have
to manually install `ocamlformat`.

#### Submitting patches

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.
[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 9b1fa5e

Please sign in to comment.