Rspack Development Guide

Note

The Rspack dev guide has been merged into the Rspack main website, this repo is no longer maintained. See: https://rspack.dev/contribute/.

The development guide is a set of guidelines and instructions that help contributors understand how to work on Rspack. It covers everything from setting up the development environment to coding style and testing guidelines.

You can read the latest version of the guide here.

The Rspack team believe that creating a development guide for Rspack is a great way to build a good relationship with the open source community. By providing clarity and consistency, lowering barriers to entry, building trust, and encouraging collaboration, we can create a strong and thriving open source project that people will want to contribute to.

Installation

cargo install mdbook mdbook-linkcheck mdbook-toc

Preview

mdbook serve --open

Credits

rspack-dev-guide is deeply inspired by rustc-dev-guide, a great example of how to encourage collaboration with the open source community.

Third Party Licenses

This project partially copies texts from the following projects:

• rustc-dev-guide(MIT)