This is an automated email from the ASF dual-hosted git repository.
JingsongLi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/paimon-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 07a9bef5 docs: correct the local verification commands (#637)
07a9bef5 is described below
commit 07a9bef5a5955320bef304aff5093751fd3389b2
Author: jackylee <[email protected]>
AuthorDate: Mon Aug 3 16:41:05 2026 +0800
docs: correct the local verification commands (#637)
---
CONTRIBUTING.md | 27 +++++++++++++++++++++------
docs/src/contributing.md | 20 ++++++++++++++++----
2 files changed, 37 insertions(+), 10 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e8559aae..07bf247b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,13 +22,28 @@
## Get Started
This is a Rust project, so [rustup](https://rustup.rs/) is a great place to
start. It provides an easy way to manage your Rust installation and toolchains.
-This is a pure Rust project, so only `cargo` is needed. Here are some common
commands to get you started:
+Rust and `cargo` are enough for the unit tests and the lint gates. Here are the
+commands CI runs, which are the ones to reproduce locally:
- `cargo check`: Analyze the current package and report errors. This is a
quick way to catch any obvious issues without a full compilation.
-- `cargo fmt`: Format the current code according to the Rust style guidelines.
This helps maintain a consistent code style throughout the project.
+- `cargo fmt --all -- --check`: Verify the code matches the Rust style
guidelines. `cargo fmt --all` rewrites the files in place.
- `cargo build`: Compile the current package. This will build the project and
generate executable binaries if applicable.
-- `cargo clippy`: Catch common mistakes and improve code quality. Clippy
provides a set of lints that can help you write better Rust code.
-- `cargo test`: Run unit tests. This will execute all the tests defined in the
project to ensure the functionality is correct.
-- `cargo bench`: Run benchmark tests. This is useful for measuring the
performance of specific parts of the code.
+- `cargo clippy --locked --all-targets --workspace --features fulltext,vortex
-- -D warnings`: Catch common mistakes and improve code quality. CI denies
warnings, so anything clippy reports fails the build.
+- `cargo test -p paimon --all-targets --features fulltext,vortex`: Run the
unit tests. Prefer this over a bare `cargo test`, which also builds the Python
binding and can fail to link `libpython` on some platforms.
+- `cargo test -p paimon-rest-server --all-targets`: Run the REST server tests.
+
+The integration suites additionally need a Paimon warehouse written by Spark,
so
+they are not pure `cargo`:
+
+```bash
+make docker-up # builds the Spark image and writes /tmp/paimon-warehouse
+cargo test -p paimon-integration-tests --all-targets
+cargo test -p paimon-datafusion --all-targets
+make docker-down # tear down when finished
+```
+
+Without that warehouse those tests fail with `TableNotExist` rather than being
+skipped. Override the location with `PAIMON_TEST_WAREHOUSE` if you need a
+different path.
### Setting up the Development Environment
1. Install Rust using `rustup`. Follow the instructions on the [rustup
website](https://rustup.rs/) to install Rust on your system.
@@ -38,7 +53,7 @@ This is a pure Rust project, so only `cargo` is needed. Here
are some common com
### Making Changes
1. Create a new branch for your changes. This helps keep your work separate
from the main development branch and makes it easier to review and merge your
changes.
2. Make your changes and ensure that the code still compiles and passes all
tests. Use the commands mentioned above to check for errors and run tests.
-3. Format your code using `cargo fmt` to ensure consistency with the project's
code style.
+3. Format your code using `cargo fmt --all` to ensure consistency with the
project's code style.
### Submitting Changes
1. Once you are satisfied with your changes, push your branch to the remote
repository.
diff --git a/docs/src/contributing.md b/docs/src/contributing.md
index 1fe01bc2..6fb2e4ca 100644
--- a/docs/src/contributing.md
+++ b/docs/src/contributing.md
@@ -39,14 +39,26 @@ rustup show
# Build the project
cargo build
-# Run all tests
-cargo test
+# Run the unit tests (a bare `cargo test` also builds the Python binding and
+# can fail to link libpython on some platforms)
+cargo test -p paimon --all-targets --features fulltext,vortex
+cargo test -p paimon-rest-server --all-targets
# Format code
-cargo fmt
+cargo fmt --all
# Lint (matches CI)
-cargo clippy --all-targets --workspace -- -D warnings
+cargo clippy --locked --all-targets --workspace --features fulltext,vortex --
-D warnings
+```
+
+The integration suites read a Paimon warehouse written by Spark, so they need
+Docker rather than `cargo` alone:
+
+```bash
+make docker-up # writes /tmp/paimon-warehouse
+cargo test -p paimon-integration-tests --all-targets
+cargo test -p paimon-datafusion --all-targets
+make docker-down
```
## Finding Issues
