Skip to content

Commit

Permalink
docs: add some notes for running tests (#194)
Browse files Browse the repository at this point in the history
I run into some problems when running the tests locally. This PR adds
the way I solved those, for future contributors.
  • Loading branch information
MegaRedHand authored Jan 8, 2025
1 parent 3300955 commit 4d0cc1f
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4d0cc1f

Please sign in to comment.