This is an automated email from the ASF dual-hosted git repository.
jeffreyvo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 5db4f50783 docs: Improve main README.md and highlight community (#9119)
5db4f50783 is described below
commit 5db4f5078398a84cf523d08ed5d83bddd418632f
Author: Andrew Lamb <[email protected]>
AuthorDate: Sun Jan 11 21:33:14 2026 -0500
docs: Improve main README.md and highlight community (#9119)
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax.
-->
- Closes #NNN.
# Rationale for this change
One of my new years resolutions is to try and encourage / build the
arrow-rs community more. Part of doing so is to lower the barrier for
new contributors with clear communication and documentation.
Thus I would like to improve the main readme
# What changes are included in this PR?
Update the README. See rendered preview here:
https://github.com/alamb/arrow-rs/blob/alamb/improved_comms_docs/README.md
1. Move community section to the top of the README file
2. Clarify that most communication happens on github
<img width="1348" height="775" alt="Screenshot 2026-01-09 at 9 33 06 AM"
src="https://github.com/user-attachments/assets/fc3f6041-478d-4170-bb40-3956764a9b8d";
/>
# Are these changes tested?
CI
# Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
If there are any breaking changes to public APIs, please call them out.
-->
---------
Co-authored-by: Jeffrey Vo <[email protected]>
---
README.md | 55 ++++++++++++++++++++++++++++++++-----------------------
1 file changed, 32 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 7726fc4c07..901448eb6a 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,32 @@
# Native Rust implementation of Apache Arrow and Apache Parquet
-Welcome to the [Rust][rust] implementation of [Apache Arrow], the popular
in-memory columnar format.
+Welcome to the [Rust][rust] implementation of [Apache Arrow], a popular
+in-memory columnar format and [Apache Parquet], a popular columnar file
+format.
+
+## Community
+
+We welcome participation from everyone and encourage you to join us, ask
+questions, help others, and get involved. All participation in the Apache Arrow
+project is governed by the Apache Software Foundation's [code of
+conduct](https://www.apache.org/foundation/policies/conduct.html).
+
+We use GitHub [issues] and [pull requests] for all technical discussions,
reviews,
+new features, bug fixes and release coordination. This ensures that all
communication
+is public and archived for future reference.
+
+The `[email protected]` mailing list is the communication channel for the
overall Apache Arrow community.
+Instructions for signing up and links to the archives can be found on the
[Arrow Community](https://arrow.apache.org/community/) page.
+
+Some community members also use the [Arrow Rust Discord
Server](https://discord.gg/YAb2TdazKQ) and the official [ASF
Slack](https://s.apache.org/slack-invite) server for informal discussions and
coordination.
+This is a great place to meet other contributors and get guidance on where to
contribute.
+However, all technical designs should also be recorded and formalized in
GitHub issues, so that they are accessible to everyone.
+In Slack, find us in the `#arrow-rust` channel and feel free to ask for an
invite via Discord, GitHub issues, or other means.
+
+There is more information in the [contributing] guide.
+
+## Repository Structure
This repository contains the following crates:
@@ -27,15 +52,16 @@ This repository contains the following crates:
| ------------------ |
---------------------------------------------------------------------------- |
------------------------------------------------ |
--------------------------------- |
| [`arrow`] | Core functionality (memory layout, arrays, low level
computations) | [docs.rs](https://docs.rs/arrow/latest) |
[(README)][arrow-readme] |
| [`arrow-flight`] | Support for Arrow-Flight IPC protocol
| [docs.rs](https://docs.rs/arrow-flight/latest) |
[(README)][flight-readme] |
-| [`parquet`] | Support for Parquet columnar file format
| [docs.rs](https://docs.rs/parquet/latest) |
[(README)][parquet-readme] |
+| [`parquet`] | Support for the [Apache Parquet] columnar file format
| [docs.rs](https://docs.rs/parquet/latest) |
[(README)][parquet-readme] |
| [`parquet_derive`] | A crate for deriving RecordWriter/RecordReader for
arbitrary, simple structs | [docs.rs](https://docs.rs/parquet-derive/latest) |
[(README)][parquet-derive-readme] |
-The current development version the API documentation in this repo can be
found [here](https://arrow.apache.org/rust).
+The current development version the API documentation can be found
[here](https://arrow.apache.org/rust).
Note: previously the [`object_store`] crate was also part of this repository,
but it has been moved to the [arrow-rs-object-store repository]
[apache arrow]: https://arrow.apache.org/
+[apache parquet]: https://parquet.apache.org/
[`arrow`]: https://crates.io/crates/arrow
[`parquet`]: https://crates.io/crates/parquet
[`parquet_derive`]: https://crates.io/crates/parquet-derive
@@ -49,7 +75,7 @@ Versioning].
Due to available maintainer and testing bandwidth, [`arrow`] crates ([`arrow`],
[`arrow-flight`], etc.) are released on the same schedule with the same
versions
-as the [`parquet`] and [`parquet-derive`] crates.
+as the [`parquet`] and [`parquet_derive`] crates.
This crate releases every month. We release new major versions (with
potentially
breaking API changes) at most once a quarter, and release incremental minor
@@ -81,7 +107,7 @@ Planned Release Schedule
### Rust Version Compatibility Policy
-arrow-rs and parquet are built and tested with stable Rust, and will keep a
rolling MSRV (minimum supported Rust version) that can only be updated in major
releases on a need by basis (e.g. project dependencies bump their MSRV or a
particular Rust feature is useful for us etc.). The new MSRV if selected will
be at least 6 months old. The minor releases are guaranteed to have the same
MSRV.
+arrow-rs and parquet are built and tested with stable Rust, and will keep a
rolling MSRV (minimum supported Rust version) that can only be updated in major
releases on an as needed basis (e.g. project dependencies bump their MSRV or a
particular Rust feature is useful for us etc.). The new MSRV if selected will
be at least 6 months old. The minor releases are guaranteed to have the same
MSRV.
Note: If a Rust hotfix is released for the current MSRV, the MSRV will be
updated to the specific minor version that includes all applicable hotfixes
preceding other policies.
@@ -152,24 +178,6 @@ including `join`s and window functions.
You can find more details about each crate in their respective READMEs.
-## Arrow Rust Community
-
-The `[email protected]` mailing list serves as the core communication
channel for the Arrow community. Instructions for signing up and links to the
archives can be found on the [Arrow
Community](https://arrow.apache.org/community/) page. All major announcements
and communications happen there.
-
-The Rust Arrow community also uses the official [ASF
Slack](https://s.apache.org/slack-invite) for informal discussions and
coordination. This is
-a great place to meet other contributors and get guidance on where to
contribute. Join us in the `#arrow-rust` channel and feel free to ask for an
invite via:
-
-1. the `[email protected]` mailing list
-2. the [GitHub Discussions][discussions]
-3. the [Discord channel](https://discord.gg/YAb2TdazKQ)
-
-The Rust implementation uses [GitHub issues][issues] as the system of record
for new features and bug fixes and
-this plays a critical role in the release process.
-
-For design discussions we generally use GitHub issues.
-
-There is more information in the [contributing] guide.
-
[rust]: https://www.rust-lang.org/
[`object_store`]: https://crates.io/crates/object-store
[arrow-readme]: arrow/README.md
@@ -180,4 +188,5 @@ There is more information in the [contributing] guide.
[ballista-readme]:
https://github.com/apache/datafusion-ballista/blob/main/README.md
[parquet-derive-readme]: parquet_derive/README.md
[issues]: https://github.com/apache/arrow-rs/issues
+[pull requests]: https://github.com/apache/arrow-rs/pulls
[discussions]: https://github.com/apache/arrow-rs/discussions
