Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 951 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 951 Bytes
Raw

Contributing to SerAPI

Thanks for willing to contribute to SerAPI! Contributing is usually as easy as opening a pull request, issue, or dropping by the Gitter channel and letting us know what you think of the tool.

Nothing special has to be kept in mind, other than standard OCaml practice, we usually follow ocp-indent guidelines, but we are liberal in some places in particular with regards to intra-line indentation.

We prefer GPG signed commits as well as Signed-off-by commits.

Commit tag conventions [work in progress]:

We have somme

  • [serlib] : Serialization lib.
  • [test] : Adding or modifying a test.
  • [sertop] : Sexp Toplevel.
  • [doc] : Documentation.
  • [build] : Build system.
  • [misc] : Code refactoring, miscellanenous
  • [proto] : Core protocol.
  • [control] : STM protocol.
  • [query] : Query protocol.
  • [parse] : Parsing protocol.
  • [print] : Printing protocol.
  • [js] : Javascript version.