From 4d0cc1fd6e751bb7e90884d86186beb0c54d61e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Wed, 8 Jan 2025 16:40:36 -0300 Subject: [PATCH] docs: add some notes for running tests (#194) I run into some problems when running the tests locally. This PR adds the way I solved those, for future contributors. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18dd65ff..ee4b63da 100644 --- a/README.md +++ b/README.md @@ -68,12 +68,25 @@ We are actively looking for contributors. Thank you for your interest. We have s To test locally :- -You need `foundry`to successfully to run it. +You need `foundry` to successfully to run it. ```bash cargo test ``` +On Mac, you might need to pull the foundry image manually specifying the platform with: + +```bash +docker pull --platform amd64 foundry-rs/foundry +``` + +Sometimes the bindings fail due to containing botched doctests. +You can exclude them from the test run with: + +```bash +cargo test --workspace --exclude eigen-utils +``` + At least 1 `approving` review is required to merge the PR. ### lint