-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: Improve main README.md and highlight community #9119
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
base: main
Are you sure you want to change the base?
Conversation
83cde1c to
a233332
Compare
| ### 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
driveby wordsmithing
|
|
||
| You can find more details about each crate in their respective READMEs. | ||
|
|
||
| ## Arrow Rust Community |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moved to the top and clarified
| # 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also note this repo has the parquet implementation
| 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 coordiation. This ensures that all communication |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| new features, bug fixes and release coordiation. This ensures that all communication | |
| new features, bug fixes and release coordination. This ensures that all communication |
Which issue does this PR close?
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
Are these changes tested?
CI
Are there any user-facing changes?