From 15ce9287fb217924b51d81bd956ff3eecf7e8d55 Mon Sep 17 00:00:00 2001 From: Josh Taylor Date: Thu, 23 Jun 2022 13:23:03 +0800 Subject: [PATCH] Add clone notes --- DEVELOPMENT.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 89dbcc994ec..af104372763 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -4,6 +4,13 @@ This crate follows the standard for developing a Rust library via `cargo`. The CI is our "ground truth" over the state of the library. Check out the different parts of the CI to understand how to test the different parts of this library locally. +## Git clone with submodules +The crate comes with additional submodules to aid with testing, to ensure you have them if you plan on testing, using `--recurse-submodules` will clone the submodules alongside the repository. + +```bash +git clone --recurse-submodules https://github.com/jorgecarleitao/arrow2 +``` + ## Testing The simplest way to test the crate is to run @@ -44,6 +51,15 @@ python parquet_integration/write_parquet.py deactivate ``` +If you receive warnings about other files not found (IPC), ensure you have all submodules: +``` +# If you didn't clone with `git clone --recurse-submodules https://github.com/jorgecarleitao/arrow2` +git submodule update --init --recursive + +# Update to the latest submodules +git submodule update --recursive --remote +``` + during development of particular parts of the crate, it is usually faster to reduce the feature set - the tests are gated to only the relevant tests of that feature set. For example, if improving JSON, you can use