Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 871 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 871 Bytes

Contributing Guide

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

Dev environment

  1. Download and install rust
  1. Download and install python3 and pip
  2. Install virtualenv
  3. Run source ./dev_bootstrap.sh

Build and test

  1. See docs/installation for more details on building
  2. Run make to build scubainit
  3. Run ./ci/test_setup.sh to build docker images necessary for unit testing
  4. 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