From 12aa4fcd0362dfd26c221e427fe2e04a39402b3d Mon Sep 17 00:00:00 2001 From: Xuanwo Date: Mon, 8 Jul 2024 14:02:05 +0800 Subject: [PATCH] docs: Fix typo and add contribute section (#9) --- Cargo.toml | 5 +---- README.md | 15 ++++++++++----- crates/paimon/Cargo.toml | 13 +++++++------ 3 files changed, 18 insertions(+), 15 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index f77154f..0acaa57 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,15 +17,12 @@ [workspace] resolver = "2" -members = [ - "crates/paimon", -] +members = ["crates/paimon"] [workspace.package] version = "0.0.0" edition = "2021" homepage = "https://paimon.apache.org/" - repository = "https://github.com/apache/paimon-rust" license = "Apache-2.0" rust-version = "1.77.1" diff --git a/README.md b/README.md index a52abac..e33c9e6 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,25 @@ # Apache Paimon Rust   [![Build Status]][actions] [![Latest Version]][crates.io] -[Build Status]: https://img.shields.io/github/actions/workflow/status/apache-rust/paimon/ci.yml -[actions]: https://github.com/apache-rust/paimon/actions?query=branch%3Amain +[Build Status]: https://img.shields.io/github/actions/workflow/status/apache/paimon-rust/ci.yml +[actions]: https://github.com/apache/paimon-rust/actions?query=branch%3Amain [Latest Version]: https://img.shields.io/crates/v/paimon.svg [crates.io]: https://crates.io/crates/paimon The rust implementation of Apache Paimon. -## Quick Start +## Issue Tracker -Working in progress +See [Tracking issues of 0.1.0 version for Apache Paimon Rust](https://github.com/apache/paimon-rust/issues/3) ## Contributing -Check out the [CONTRIBUTING.md](./CONTRIBUTING.md) guide for more details on getting started with contributing to this project. +Apache Paimon Rust is an exciting project currently under active development. Whether you're looking to use it in your projects or contribute to its growth, there are several ways you can get involved: + +- Follow the [Contributing Guide](CONTRIBUTING.md) to contribute. +- Create new [Issue](https://github.com/apache/paimon-rust/issues/new) for bug reportor or feature request. +- Start discussion thread at [dev mailing list](mailto:dev@paimon.apache.org) ([subscribe]() / [unsubscribe]() / [archives](https://lists.apache.org/list.html?dev@paimon.apache.org)) +- Talk to community directly at [Slack #paimon channel](https://join.slack.com/t/the-asf/shared_invite/zt-2l9rns8pz-H8PE2Xnz6KraVd2Ap40z4g). ## Getting help diff --git a/crates/paimon/Cargo.toml b/crates/paimon/Cargo.toml index 1754ee6..0d48b77 100644 --- a/crates/paimon/Cargo.toml +++ b/crates/paimon/Cargo.toml @@ -16,14 +16,15 @@ # under the License. [package] -categories = ["command-line-utilities"] -description = "The rust implementation of paimon" +categories = ["database"] +description = "The rust implementation of Apache Paimon" documentation = "https://docs.rs/paimon" -repository = "https://github.com/apache/paimon-rust" -edition = "2021" -license = "Apache-2.0" name = "paimon" -version = "0.0.0" + +repository.workspace = true +edition.workspace = true +license.workspace = true +version.workspace = true [dependencies] serde = { version = "1", features = ["derive"] }