|
Packit |
9ee409 |
= Contributing to OCamlbuild
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
Any contribution is warmly welcome!
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
Bugs in OCamlbuild itself should be reported on https://github.com/ocaml/ocamlbuild/issues[the github bugtracker].
|
|
Packit |
9ee409 |
Any OCamlbuild-related question can also be asked on the mailto:caml-list@inria.fr[caml-list mailing-list].
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
Contributions in the form of patches are most welcome.
|
|
Packit |
9ee409 |
We welcome pull requests on the https://github.com/ocaml/ocaml/pulls[GitHub repository], but you can also email a patch if that is your preference.
|
|
Packit |
9ee409 |
OCamlbuild is free software, licensed under the GNU LGPL, and we do our best to review, give feedback, and integrate proposed patches.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
In particular, if you try to understand the implementation or documentation, and understanding some part of it requires excessive effort, a patch containing implementation or documentation comments to clarify it to future readers is an excellent idea.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
== The OCamlbuild manual
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
This repository also hosts https://github.com/ocaml/ocamlbuild/tree/master/manual/manual.adoc[the OCamlbuild manual].
|
|
Packit |
9ee409 |
Feel free to ask questions about unclear part of the manual, or to contribute extra explanations.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
The documentation contains a set of https://github.com/ocaml/ocamlbuild/tree/master/manual/examples[examples] that anyone can help grow.
|
|
Packit |
9ee409 |
If there is a typical kind of setting that you've reused across several projects, is clear and informative, and is not represented in existing examples, feel free to submit it.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
You can also help complete the documentation by integrating http://ocaml.org/learn/tutorials/ocamlbuild/[ocaml.org Wiki] content in the OCamlbuild manual.
|
|
Packit |
9ee409 |
This Wiki has a lot of valuable information, but for a mix of social and technical reasons it hasn't evolved into a good alternate documentation that we could point beginners to. We hope this manual can fill this gap.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
You can also use https://github.com/ocaml/ocamlbuild/issues[our issue tracker] to comment on precise or general shortcomings of the present documentation, such as:
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
* Things that are missing and must be present;
|
|
Packit |
9ee409 |
* Things that are here but should be shortened; or
|
|
Packit |
9ee409 |
* Things of which you would like to change the presentation.
|
|
Packit |
9ee409 |
|
|
Packit |
9ee409 |
A patch is even more useful than a bug report.
|
|
Packit |
9ee409 |
For less precise comments (or to send patches), you can send an e-mail to (gabriel dot scherer at gmail).
|
|
Packit |
9ee409 |
|