Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Commit

Permalink
Add clone notes
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuataylor committed Jun 23, 2022
1 parent 664e39c commit 15ce928
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 15ce928

Please sign in to comment.