diff options
Diffstat (limited to 'test/external/metalang99/CONTRIBUTING.md')
| -rw-r--r-- | test/external/metalang99/CONTRIBUTING.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/test/external/metalang99/CONTRIBUTING.md b/test/external/metalang99/CONTRIBUTING.md new file mode 100644 index 0000000..2e9e0d1 --- /dev/null +++ b/test/external/metalang99/CONTRIBUTING.md @@ -0,0 +1,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! |