Skip to content

Commit

Permalink
add steps for dev env, and specifics for build + test
Browse files Browse the repository at this point in the history
  • Loading branch information
funkecoder23 authored and funkecoder23 committed May 27, 2024
1 parent 325fb58 commit cb4e229
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
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
7 changes: 6 additions & 1 deletion dev_bootstrap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ then
exit 1
fi

python3 -m virtualenv venv

if [ python3 -m virtualenv venv ]; then
echo "Error creating venv. Do you have virtualenv installed?"
exit 1
fi

source venv/bin/activate
pip install -r requirements.txt
pip install -e .

0 comments on commit cb4e229

Please sign in to comment.