Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.44 KB

Contributing to Ketrew

Issues/Questions

The best place to discuss Ketrew is within Github's issues (used even for questions).

Contributions

We follow the usual pull-requests mechanism, trying to have meaningful and readable commits (which all at least compile).

Before working on something, submit an issue if there is not already one; and comment on the issue about your intentions. Then, mention the issue in your commit messages.

Before submitting a PR, please check that the tests still run, and the documentation builds.

We don't git push -f, or use rebase once a PR is started, please address peer-review comments by adding commits to your PR (pushing to the same branch on your repository).

OCaml Guidelines

Please refer to our OCaml Guidelines.

On top of that, for Ketrew:

  • We use a pervasive Error monad embedded in Lwt (see pvem_lwt_unix) for all the library (i.e. internal) code. This makes type signatures scary as they ought to be, and forces self-documenting code discipline.
  • But in contrast, the EDSL should be much simpler, in order to be picked up by OCaml-beginners.

More information for developers is available in the documentation.