Skip to content

Commit

Permalink
Merge pull request #256 from FunkeCoder23/update-contrib-guide
Browse files Browse the repository at this point in the history
Update Contributing guide
  • Loading branch information
JonathonReinhart authored May 29, 2024
2 parents 12d7f09 + d68845f commit 69b5a0b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@
*This file is incomplete. Feel free to open an issue if there is missing
information you desire.*

## Dev environment

1. Download and install [rust](https://www.rust-lang.org/tools/install)
<!-- Specific python version? -->
2. Download and install python3 and pip
3. Install `virtualenv`
4. 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](https://black.readthedocs.io/)
code style. Code format in PRs is verified by a GitHub action.
Expand Down

0 comments on commit 69b5a0b

Please sign in to comment.