Giter Club home page Giter Club logo

incubator-horaedb-proto's Introduction

Protocol of Apache HoraeDB™

Crates.io Go Reference Maven Central

Protocol buffer files for HoraeDB. Projects that manage generated code of different languages are also in this repository. They act as underlying dependencies of the client, server, and meta.

User Guide

Rust

cargo add horaedbproto

Golang

go get github.com/apache/incubator-horaedb-proto/golang

Java

Add a maven dependency to your project.

<dependency>
    <groupId>org.apache.horaedb</groupId>
    <artifactId>horaedb-proto-internal</artifactId>
    <version>${horaedb-proto-internal.version}</version>
</dependency>

Developer Guide

After modifying the proto files, something else for different programming languages should be done.

Java

  1. Name the maven project to a new version.
  2. Rebuild the maven project in the java directory (During the build process, java code for the latest proto will be generated).
  3. Publish the build result to the central maven repository.

Rust

As for the Rust projects that depend on this project, everything will be generated during the build process themselves. So nothing else needs to be done for Rust.

Golang

  1. Install Protocol Buffers v25.1 compiler.
  2. Execute make go.

incubator-horaedb-proto's People

Contributors

archerny avatar baojinri avatar chunshao90 avatar jiacai2050 avatar michaelleehz avatar rachelint avatar shikaiwi avatar tanruixiang avatar tisonkun avatar waynexia avatar zuliangwang avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

incubator-horaedb-proto's Issues

Add linter for proto files

Describe This Problem

Currently, there is no lint to harness the style of the protobuf files.

Proposal

  • We can use such a lint command to format the protobuf files: clang-format -style=google;
  • And let's add this to CI.

Additional Context

No response

Support code style check for proto files

Now there is no code style checker on the proto files, which may cause a mess.

Here is a proposal: Add GitHub workflow to run clang-format -style=google to ensure the consistency of the proto files' style.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.