General Information
Coding Style
When refactoring, writing or altering scripts or other files, adhere to these rules:
- Adjust your style of coding to the style that is already present! Even if you do not like it, this is due to consistency. There was a lot of work involved in making all scripts consistent.
- Use
shellcheck
to check your scripts! Your contributions are checked by GitHub Actions too, so you will need to do this. You can lint your work withmake lint
to check against all targets. - Use the provided
.editorconfig
file. - Use
/bin/bash
instead of/bin/sh
in scripts
Tests
To run the test suite, you will need to
- Install Docker
- Install
jq
(under Ubuntu, usesudo apt-get -y install jq
) - Execute
git submodule update --init --recursive
if you haven't already initialized the git submodules - Execute
make clean all
Can I use MacOS?
We do not support running linting, tests, etc on macOS at this time. Please use a linux VM.
Running a Specific Test
To run a specific test, use make build generate-accounts test/<TEST NAME>
, where <TEST NAME>
is the file name of the test (for more precision use a relative path: test/test/<PATH>
) excluding the .bats
suffix.
To run only the tests in template.bats
, use make test/template
(or make test/parallel/set2/template
).
Documentation
You will need to have Docker installed. Navigate into the docs/
directory. Then run:
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material
This serves the documentation on your local machine on port 8000
. Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.