Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
## Contributing to jsCoq
Thanks for willing to contribute to jsCoq! Contributing is as easy as
opening a pull request, issue, or dropping by the Gitter channel and
talking to us.
### Coding style
Nothing very special has to be kept in mind, we follow standard OCaml
practice, with `ocp-indent` and `ocamlformat` indentation guidelines,
but we are liberal in some places, in particular with regards to
intra-line indentation. We compile with a very strict set of warnings.
### Review and merge guidelines
We recommend that most non-trivial changes take place using pull
requests. Any contributor can merge a pull request [including their
own] provide the pull request:
- has updated the `CHANGES.md` file,
- passes Travis CI,
- has at least one approving review from other contributor.
Exceptions to this rule is when a review cannot happen due to lack of
a second contributor with that particular expertise.
We prefer GPG signed commits as well as `Signed-off-by` commits.
### Commit tag conventions [work in progress]:
We have some [soft] commit tag conventions:
- [jscoq]: ML/Coq interface
- [ui]: Html/Css commit
- [cm]: CodeMirror provider
- [libs]: Coq Library support and format
- [doc]: Documentation
- [addons]: Addons support
- [build]: Build system
- [feature]: Adding a new feature
- [bugfix]: Bug fix
- [refactor]: Refactoring commit (no functional change intended)
- [ci] / [travis]: Continuous integration
- [test]: Adding or modifying a test
- [misc]: Miscellanenous small things