Skip to content

Latest commit

 

History

History
 
 

dev

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Contributing Quick Start

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.

Getting in Touch

See also Getting Help

Issue Labels

CI

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