Contributing Guide

This file is incomplete. Feel free to open an issue if there is missing information you desire.

Dev environment

Download and install rust

Download and install python3 and pip
Install virtualenv
Run source ./dev_bootstrap.sh

Build and test

See docs/installation for more details on building
Run make to build scubainit
Run ./ci/test_setup.sh to build docker images necessary for unit testing
Run ./run_unit_tests.sh, static_analysis.sh and run_full_tests.py to test

Code Format

Scuba is compliant with the Black code style. Code format in PRs is verified by a GitHub action.

To check code formatting:

$ ./code_format.py

To fix code formatting:

$ ./code_format.py --fix