File: CONTRIBUTING.md

package info (click to toggle)
js-of-ocaml-ocamlbuild 5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 208 kB
  • sloc: ml: 85; makefile: 15; sh: 9
file content (29 lines) | stat: -rw-r--r-- 1,173 bytes parent folder | download | duplicates (2)
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
# Contributing to Js_of_ocaml-ocamlbuild

## Reporting Issues

If you encounter a problem when using js_of_ocaml-ocamlbuild or if you have any questions, please open a [GitHub issue](https://github.com/ocsigen/js_of_ocaml-ocamlbuild/issues/).

1. Check first if your issue has already been [reported](https://github.com/ocsigen/js_of_ocaml-ocamlbuild/issues/).
2. Describe the expected and actual behavior.
3. Do not unsubscribe from the issue until it is closed, the maintainers may ask for your feedback.

## Pull Requests

We actively welcome pull requests.

1. Prior to investing a large amount of time into significant or invasive changes, it is likely more efficient to first open an issue for discussion and planning.
2. Install all dependencies (see [Install dependencies](#install-dependencies))
3. Fork the repository and create your branch from `master`.
4. If you have added code that should be tested, add tests.
5. Ensure tests still pass (see [Running the tests](#running-the-tests)).
6. Add an entry in the changelog `CHANGES.md`

### Install dependencies
```
opam install --deps-only -t js_of_ocaml-ocamlbuild
```

### Running the tests

Run `make tests`.