hack.md

Hacking on msu

You believe in the project, and now you want to make it better, with code

dependencies:

We are using:

• shellcheck - static analysis
• bats - test runner
• a2x - asciidoc converter
• hub - Github terminal client

To ensure reproducibility, we are using git submodules.

prepare environment:

Installing (some of) the dependencies:

$ make deps

running tests:

Running tests fully:

$ make test

Some of the different types of tests can be invoked separately.

$ make test.lint          # run static analysis
$ make test.unit          # run unit tests
$ make test.doc           # run tests on documentation

building docs:

You can build the manpages using:

$ make doc