docs: correct the local verification commands - #637
Open
jackylee-ch wants to merge 1 commit into
Open
Conversation
`CONTRIBUTING.md` and `docs/src/contributing.md` both recommend a bare `cargo test`, which on macOS aborts before running a single test: the workspace includes the `pypaimon_rust` binding and the test binary fails to link `libpython3.12.dylib`. CI never runs it that way — it uses `cargo test -p paimon --all-targets --features fulltext,vortex`. `CONTRIBUTING.md` also claimed "only `cargo` is needed" and listed `cargo bench`. Four of the five integration suites read a Paimon warehouse written by Spark via `make docker-up`, and without it 57 tests fail with `TableNotExist` instead of being skipped. There is no `[[bench]]` target or benchmark harness in the workspace, so `cargo bench` runs nothing. List the commands CI actually runs, including the `--features` and `-D warnings` flags the `check` job uses, and document the Docker step the integration suites need.
jackylee-ch
force-pushed
the
docs/fix-contributing-commands
branch
from
July 31, 2026 12:04
38236fe to
c0be073
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both
CONTRIBUTING.mdanddocs/src/contributing.mdtell contributors to run abare
cargo test. On macOS that aborts before running a single test — theworkspace includes the
pypaimon_rustbinding and the test binary fails to linklibpython3.12.dylib(SIGABRT). CI never runs it that way; it usescargo test -p paimon --all-targets --features fulltext,vortex.CONTRIBUTING.mdalso claimed "onlycargois needed" and listedcargo bench.Four of the five integration suites read a Paimon warehouse written by Spark via
make docker-up; without it 57 tests fail withTableNotExistrather than beingskipped. And there is no
[[bench]]target or benchmark harness in theworkspace, so
cargo benchruns nothing.Fix: list the commands CI actually runs, including the
--featuresand-D warningsflags from thecheckjob, and document the Docker step theintegration suites require. Every command in the new text was run locally.