The foundry Rust project is organized as a regular Cargo workspace.
Simply running
$ cargo test
should be enough to get you started!
To learn more about how foundry's tools works, see ./architecture.md. It also explains the high-level layout of some aspects of the source code. To read more about how to use it, see 📖 Foundry Book Note though, that the internal documentation is very incomplete.
See also Getting Help
- good-first-issue are good issues to get into the project.
- D-easy, D-average, D-hard, D-chore, labels indicate how hard it would be to write a fix or add a feature.
We use GitHub Actions for CI.
We use cargo-nextest as the test runner
If cargo test passes locally, that's a good sign that CI will be green as well.
We also have tests that make use of forking mode which can be long running if the required state is not already cached locally.
Forking-related tests are executed exclusively in a separate CI job, they are identified by fork in their name.
So all of them can be easily skipped by cargo t -- --skip fork