Introduction

This guide is intended to be used by contributors to learn about how to develop RisingWave. The instructions about how to submit code changes are included in contribution guidelines.

If you have questions, you can search for existing discussions or start a new discussion in the Discussions forum of RisingWave, or ask in the RisingWave Community channel on Slack. Please use the invitation link to join the channel.

To report bugs, create a GitHub issue.

Note: the url was previously for the crate rustdocs, and now they are moved to path /risingwave/rustdoc

Read the design docs

Before you start to make code changes, ensure that you understand the design and implementation of RisingWave. We recommend that you read the design docs listed in docs/README.md first.

You can also read the crate level documentation for implementation details, or run ./risedev doc to read it locally.

Learn about the code structure

• The src folder contains all of the kernel components, refer to src/README.md for more details, which contains more details about Design Patterns in RisingWave.
• The docker folder contains Docker files to build and start RisingWave.
• The e2e_test folder contains the latest end-to-end test cases.
• The docs folder contains the design docs. If you want to learn about how RisingWave is designed and implemented, check out the design docs here.
• The dashboard folder contains RisingWave dashboard.