Skip to content

Commit 924e1fe

Browse files
alambJefffrey
authored andcommitted
docs: Improve main README.md and highlight community (apache#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 <jeffrey.vo.australia@gmail.com>
1 parent 6234ee0 commit 924e1fe

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

README.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,49 @@
1919

2020
# Native Rust implementation of Apache Arrow and Apache Parquet
2121

22-
Welcome to the [Rust][rust] implementation of [Apache Arrow], the popular in-memory columnar format.
22+
Welcome to the [Rust][rust] implementation of [Apache Arrow], a popular
23+
in-memory columnar format and [Apache Parquet], a popular columnar file
24+
format.
25+
26+
## Community
27+
28+
We welcome participation from everyone and encourage you to join us, ask
29+
questions, help others, and get involved. All participation in the Apache Arrow
30+
project is governed by the Apache Software Foundation's [code of
31+
conduct](https://www.apache.org/foundation/policies/conduct.html).
32+
33+
We use GitHub [issues] and [pull requests] for all technical discussions, reviews,
34+
new features, bug fixes and release coordination. This ensures that all communication
35+
is public and archived for future reference.
36+
37+
The `dev@arrow.apache.org` mailing list is the communication channel for the overall Apache Arrow community.
38+
Instructions for signing up and links to the archives can be found on the [Arrow Community](https://arrow.apache.org/community/) page.
39+
40+
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.
41+
This is a great place to meet other contributors and get guidance on where to contribute.
42+
However, all technical designs should also be recorded and formalized in GitHub issues, so that they are accessible to everyone.
43+
In Slack, find us in the `#arrow-rust` channel and feel free to ask for an invite via Discord, GitHub issues, or other means.
44+
45+
There is more information in the [contributing] guide.
46+
47+
## Repository Structure
2348

2449
This repository contains the following crates:
2550

2651
| Crate | Description | Latest API Docs | README |
2752
| ------------------ | ---------------------------------------------------------------------------- | ------------------------------------------------ | --------------------------------- |
2853
| [`arrow`] | Core functionality (memory layout, arrays, low level computations) | [docs.rs](https://docs.rs/arrow/latest) | [(README)][arrow-readme] |
2954
| [`arrow-flight`] | Support for Arrow-Flight IPC protocol | [docs.rs](https://docs.rs/arrow-flight/latest) | [(README)][flight-readme] |
30-
| [`parquet`] | Support for Parquet columnar file format | [docs.rs](https://docs.rs/parquet/latest) | [(README)][parquet-readme] |
55+
| [`parquet`] | Support for the [Apache Parquet] columnar file format | [docs.rs](https://docs.rs/parquet/latest) | [(README)][parquet-readme] |
3156
| [`parquet_derive`] | A crate for deriving RecordWriter/RecordReader for arbitrary, simple structs | [docs.rs](https://docs.rs/parquet-derive/latest) | [(README)][parquet-derive-readme] |
3257

33-
The current development version the API documentation in this repo can be found [here](https://arrow.apache.org/rust).
58+
The current development version the API documentation can be found [here](https://arrow.apache.org/rust).
3459

3560
Note: previously the [`object_store`] crate was also part of this repository,
3661
but it has been moved to the [arrow-rs-object-store repository]
3762

3863
[apache arrow]: https://arrow.apache.org/
64+
[apache parquet]: https://parquet.apache.org/
3965
[`arrow`]: https://crates.io/crates/arrow
4066
[`parquet`]: https://crates.io/crates/parquet
4167
[`parquet_derive`]: https://crates.io/crates/parquet-derive
@@ -49,7 +75,7 @@ Versioning].
4975

5076
Due to available maintainer and testing bandwidth, [`arrow`] crates ([`arrow`],
5177
[`arrow-flight`], etc.) are released on the same schedule with the same versions
52-
as the [`parquet`] and [`parquet-derive`] crates.
78+
as the [`parquet`] and [`parquet_derive`] crates.
5379

5480
This crate releases every month. We release new major versions (with potentially
5581
breaking API changes) at most once a quarter, and release incremental minor
@@ -81,7 +107,7 @@ Planned Release Schedule
81107

82108
### Rust Version Compatibility Policy
83109

84-
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.
110+
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.
85111

86112
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.
87113

@@ -152,24 +178,6 @@ including `join`s and window functions.
152178

153179
You can find more details about each crate in their respective READMEs.
154180

155-
## Arrow Rust Community
156-
157-
The `dev@arrow.apache.org` 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.
158-
159-
The Rust Arrow community also uses the official [ASF Slack](https://s.apache.org/slack-invite) for informal discussions and coordination. This is
160-
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:
161-
162-
1. the `dev@arrow.apache.org` mailing list
163-
2. the [GitHub Discussions][discussions]
164-
3. the [Discord channel](https://discord.gg/YAb2TdazKQ)
165-
166-
The Rust implementation uses [GitHub issues][issues] as the system of record for new features and bug fixes and
167-
this plays a critical role in the release process.
168-
169-
For design discussions we generally use GitHub issues.
170-
171-
There is more information in the [contributing] guide.
172-
173181
[rust]: https://www.rust-lang.org/
174182
[`object_store`]: https://crates.io/crates/object-store
175183
[arrow-readme]: arrow/README.md
@@ -180,4 +188,5 @@ There is more information in the [contributing] guide.
180188
[ballista-readme]: https://github.com/apache/datafusion-ballista/blob/main/README.md
181189
[parquet-derive-readme]: parquet_derive/README.md
182190
[issues]: https://github.com/apache/arrow-rs/issues
191+
[pull requests]: https://github.com/apache/arrow-rs/pulls
183192
[discussions]: https://github.com/apache/arrow-rs/discussions

0 commit comments

Comments
 (0)