diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f45173e6..e1c22d29e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,33 @@ cargo run --package limbo_cli --bin limbo database.db ``` Run tests: +```console +cargo test +``` +### Running Tests On Linux +> [!NOTE] +> These steps have been tested on Ubuntu Noble 24.04.2 LTS + +Running tests on Linux and getting them pass requires a few additional steps + +1. Install [SQLite](https://www.sqlite.org/index.html) +```console +sudo apt install sqlite3 libsqlite3-dev +``` +2. Build Cargo +```console +cargo build -p limbo_sqlite3 --features capi +``` +3. Install Python3 +```console +sudo apt install python3.12 python3.12-dev +``` +4. Set env var for Maturin +```console +export PYO3_PYTHON=$(which python3) +``` +5. Run tests ```console cargo test ```