If you encounter a problem when using js_of_ocaml or if you have any questions, please open a GitHub issue.
- Check first if your issue has already been reported.
- Include the version of ocaml and js_of_ocaml you are using (
ocamlc -version
,js_of_ocaml --version
). - Describe the expected and actual behavior.
- Do not unsubscribe from the issue until it is closed, the maintainers may ask for your feedback.
We actively welcome pull requests.
- Prior to investing a large amount of time into significant or invasive changes, it is likely more efficient to first open an issue for discussion and planning.
- Install all dependencies (see Install dependencies)
- Fork the repository and create your branch from
master
. - If you have added code that should be tested, add tests.
- Ensure tests still pass (see Running the tests).
- Add an entry in the changelog
CHANGES.md
opam install --deps-only -t js_of_ocaml js_of_ocaml-lwt js_of_ocaml-compiler js_of_ocaml-toplevel js_of_ocaml-ppx js_of_ocaml-ppx_deriving_json js_of_ocaml-tyxml
opam install odoc lwt_log cohttp-lwt-unix yojson ocp-indent graphics higlo
Tests are maintained for a single version of the OCaml compiler (currently 4.13).
Make sure to use the correct opam switch (e.g. opam switch 4.13.1
).
Run make tests
.