blob: 2e9e0d113ba0fe9d1acc97badbfc8b459277b436 (
plain) (
blame)
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
|
# Contributing
To introduce changes:
1. Fork this repository.
2. Create your own branch `xxx` from `master`.
3. Make required changes.
4. Open a PR to `master` from your `xxx`.
5. Wait until it gets reviewed.
To be able to work with low-level stuff such as the interpreter, I highly recommend to first observe the [Cloak Wiki].
To be able to work with the metalanguage itself, some basic familiarity with programming language theory is expected. For learning materials, see https://github.com/steshaw/plt.
[Cloak Wiki]: https://github.com/pfultz2/Cloak/wiki/C-Preprocessor-tricks,-tips,-and-idioms
Some useful scripts are:
| Description | Command |
|----------|----------|
| Format all the code base | `./scripts/fmt.sh` |
| Check code formatting | `./scripts/check-fmt.sh` |
| Test only `tests/` | `./scripts/test.sh` |
| Test only `examples/` | `./scripts/test-examples.sh` |
| Test both `tests/` and `examples/` | `./scripts/test-all.sh` |
| Generate the documentation | `./scripts/docs.sh` |
| Open the documentation | `./scripts/open-docs.sh` |
| Generate the specification | `./scripts/spec.sh` |
| Open the specification | `./scripts/open-spec.sh` |
| Run the benchmarks | `./scripts/bench.sh` |
Happy hacking!
|
