Skip to content

Update the README file to include a development section. #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phillipleblanc merged 1 commit into from
Jan 14, 2026
Merged

Update the README file to include a development section. #526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ let ctx = SessionContext::with_state(state);
- Flight SQL
- ODBC

## Development

During development, and especially before opening a PR, it is recommended to run:

```bash
cargo check --all-features --all
```

This verifies that all features and all crates compile without building
binaries. It’s much faster than cargo build and avoids issues with
native/shared library dependencies and heavy compilation.

## Examples (in Rust)

Run the included examples to see how to use the table providers:
Expand Down