From 1e62df9c8f4e48d704ed56d3fa9ccb13a69ac76b Mon Sep 17 00:00:00 2001 From: Keith Lee Date: Mon, 12 Jan 2026 10:52:55 +0000 Subject: [PATCH 1/4] Add DEVELOPMENT.md --- DEVELOPMENT.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..705d30b --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,65 @@ + + +# Development Guide + +Welcome to the development guide of `fluss-rust`! This project builds `fluss-rust` client and language specific bindings. + +## Pre-requisites + +- protobuf +- rust + +You can install these using your favourite package / version manager. Example installation using mise: + +```bash +mise install protobuf +mise install rust +``` + +We recommend [RustRover](https://www.jetbrains.com/rust/) IDE to work with fluss-rust code base. + +## Project directories + +Source files are organized in the following manner + +1. `crates/fluss` - fluss rust client crate source +2. `crates/example` - fluss rust client example +3. `bindings` - bindings to other languages e.g. C++ under `bindings/cpp` and Python under `bindings/python` + +## Building & Testing + +See [quickstart](README.md#quick-start) for steps to run example code. + +Running all unit tests for fluss rust client: + +```bash +cargo test --release +``` + + + +### Formatting and Clippy + +Our CI runs cargo formatting and clippy to help keep the code base styling tidy and readable. Run the following commands and address any errors or warnings to ensure that your PR can complete CI successfully. + +```bash +cargo fmt --all +cargo clippy --all-targets --fix --allow-dirty --allow-staged +``` + From 4746c8ebab56182d73956fc1fc128389546abb2e Mon Sep 17 00:00:00 2001 From: Keith Lee Date: Tue, 13 Jan 2026 13:28:42 +0000 Subject: [PATCH 2/4] Fix typo --- DEVELOPMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 705d30b..7475ab7 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -39,7 +39,7 @@ We recommend [RustRover](https://www.jetbrains.com/rust/) IDE to work with fluss Source files are organized in the following manner 1. `crates/fluss` - fluss rust client crate source -2. `crates/example` - fluss rust client example +2. `crates/examples` - fluss rust client examples 3. `bindings` - bindings to other languages e.g. C++ under `bindings/cpp` and Python under `bindings/python` ## Building & Testing From fcabfde057dfcbc2ffcaa6acd617cfd98f601f82 Mon Sep 17 00:00:00 2001 From: Keith Lee Date: Tue, 13 Jan 2026 14:08:58 +0000 Subject: [PATCH 3/4] Address comments --- DEVELOPMENT.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 54 insertions(+), 4 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 7475ab7..f6f24fa 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -32,16 +32,61 @@ mise install protobuf mise install rust ``` +## IDE Setup + We recommend [RustRover](https://www.jetbrains.com/rust/) IDE to work with fluss-rust code base. +### Importing fluss-rust + +1. On your terminal, clone fluss-rust project from GitHub + ```bash + git clone https://github.com/apache/fluss-rust.git + ``` +1. Open RustRover, on `Projects` tab, click `Open` and navigate to the root directory of fluss-rust +1. Click `Open` + +### Copyright Profile + +Fluss and Fluss-rust are Apache projects and as such every files need to have Apache licence header. This can be automated in RustRover by adding a Copyright profile: + +1. Go to `Settings` -> `Editor` -> `Copyright` -> `Copyright Profiles`. +1. Add a new profile and name it `Apache`. +1. Add the following text as the license text: + ``` + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + ``` +1. Go to `Editor` -> `Copyright` and choose the `Apache` profile as the default profile for this project. +1. Click `Apply` + +We also use line comment formatting for licence headers. +1. Go to `Editor` -> `Copyright` -> `Formatting` -> `Rust` +1. Choose `Use custom formatting` +1. Choose `Use line comment` + ## Project directories Source files are organized in the following manner 1. `crates/fluss` - fluss rust client crate source -2. `crates/examples` - fluss rust client examples -3. `bindings` - bindings to other languages e.g. C++ under `bindings/cpp` and Python under `bindings/python` - +1. `crates/examples` - fluss rust client examples +1. `bindings` - bindings to other languages e.g. C++ under `bindings/cpp` and Python under `bindings/python` +1. Click `Apply` +2. ## Building & Testing See [quickstart](README.md#quick-start) for steps to run example code. @@ -49,9 +94,14 @@ See [quickstart](README.md#quick-start) for steps to run example code. Running all unit tests for fluss rust client: ```bash -cargo test --release +cargo test --workspace ``` +Running all integration test casesL + +```bash +cargo test --features integration_tests --workspace +``` ### Formatting and Clippy From 6e6d5f923eb90a28a0513a192149b5a4d15d1682 Mon Sep 17 00:00:00 2001 From: Keith Lee Date: Tue, 13 Jan 2026 14:15:33 +0000 Subject: [PATCH 4/4] Address comments --- DEVELOPMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index f6f24fa..a8a6d53 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -97,7 +97,7 @@ Running all unit tests for fluss rust client: cargo test --workspace ``` -Running all integration test casesL +Running all integration test cases: ```bash cargo test --features integration_tests --workspace