Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix typo and add contribute section #9

Merged
merged 2 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Xuanwo marked this conversation as resolved.
Show resolved Hide resolved
[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:[email protected]) ([subscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/[email protected]))
- Talk to community directly at [Slack #paimon channel](https://join.slack.com/t/the-asf/shared_invite/zt-2l9rns8pz-H8PE2Xnz6KraVd2Ap40z4g).

## Getting help

Expand Down
13 changes: 7 additions & 6 deletions crates/paimon/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Xuanwo marked this conversation as resolved.
Show resolved Hide resolved
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"] }
Expand Down
Loading