From 35a315a5e89013da08ee8bab8382209eba7de27d Mon Sep 17 00:00:00 2001 From: EnRaiha <15997552+EnRaiha@users.noreply.github.com> Date: Fri, 18 Sep 2026 06:49:57 +0800 Subject: [PATCH] docs(test): document the CI stack size for local runs RUST_MIN_STACK replaces the default stack size for every thread that sets none, on every platform. Debug-profile test binaries overflow the 2 MiB default; 32 MiB is the value CI already sets (.github/workflows/test.yml). The tracked .cargo/config.toml attempt is dropped: .gitignore ignores .cargo/ because that file is each contributor's local override. --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 628d2473c..27bb0046b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,7 +87,8 @@ cd nodedb cargo build --release # Run the full test suite -cargo nextest run --all-features +# Debug-profile test binaries overflow the 2 MiB thread default; 32 MiB is the value CI sets. +RUST_MIN_STACK=33554432 cargo nextest run --all-features ``` **Why nextest, not `cargo test`?** The `.config/nextest.toml` defines a `cluster` test group that serializes 3-node integration tests and retries known-flaky ones. `cargo test` ignores all of that and will hang or fail on the cluster suite.