Skip to main content

Contributing

MEV-Boost is open-source software maintained by Flashbots. Contributions are welcome from the community.

Development Setup​

Prerequisites​

Clone and Build​

git clone https://github.com/flashbots/mev-boost.git
cd mev-boost
make build

Running Tests​

# Run unit tests
make test

# Run linter
make lint

# Run integration tests with mergemock
make run-mergemock-integration

Running Locally​

# Run with default settings pointed at a test relay
make run

Branch Strategy​

  • develop — The default branch. All pull requests target develop.
  • main — Stable release branch. Merged from develop during releases.

Pull Request Guidelines​

  1. Fork the repository and create your branch from develop.
  2. Write tests for any new functionality.
  3. Run make test and make lint before submitting.
  4. Keep PRs focused — one feature or fix per PR.
  5. Write a clear description explaining what the change does and why.

Reporting Issues​

Contributing to These Docs​

This documentation site is maintained separately at flashbots/mev-boost.org.

git clone https://github.com/flashbots/mev-boost.org.git
cd mev-boost.org
npm install
npm start

Docs are written in Markdown/MDX and live in the docs/ directory. See the Docusaurus docs for formatting guidance.

Community​