CONTRIBUTING.md

Contributing

Setup your development environment

You need Opam, you can install it by following Opam's documentation.

With Opam installed, you can install the dependencies with:

make dev

Then, build the project with:

make build

Running Binary

After building the project, you can run the main binary that is produced.

make start

Running Tests

You can run the test compiled executable:

make test

Building documentation

Documentation for the libraries in the project can be generated with:

make doc
open-cli $(make doc-path)

This assumes you have a command like open-cli installed on your system.

NOTE: On macOS, you can use the system command open, for instance open $(make doc-path)

Repository Structure

The following snippet describes Tyxml Components's repository structure.

.
├── bin/
|   Source for tyxml-components's binary. This links to the library defined in `lib/`.
│
├── lib/
|   Source for Tyxml Components's library. Contains Tyxml Components's core functionnalities.
│
├── test/
|   Unit tests and integration tests for Tyxml Components.
│
├── dune-project
|   Dune file used to mark the root of the project and define project-wide parameters.
|   For the documentation of the syntax, see https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
│
├── LICENSE
│
├── Makefile
|   Make file containing common development command.
│
├── README.md
│
└── tyxml-components.opam
    Opam package definition.
    To know more about creating and publishing opam packages, see https://opam.ocaml.org/doc/Packaging.html.