luoyuxia commented on code in PR #155: URL: https://github.com/apache/fluss-rust/pull/155#discussion_r2686436656
########## DEVELOPMENT.md: ########## @@ -0,0 +1,65 @@ +<!-- + 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. +--> + +# 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 +``` + Review Comment: add a guide for running all it case? ``` cargo test --features integration_tests --workspace ``` ########## DEVELOPMENT.md: ########## @@ -0,0 +1,65 @@ +<!-- + 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. +--> + +# 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. Review Comment: Add an sectioin for IDE step up? Such as Copyright Profile? see https://fluss.apache.org/community/dev/ide-setup/#copyright-profile ########## DEVELOPMENT.md: ########## @@ -0,0 +1,65 @@ +<!-- + 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. +--> + +# 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 Review Comment: ```suggestion cargo test --workspace ``` Align with the command in github ci ? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
