Clean up README.md in advance of the 5.0 release #536
Conversation
github-actions
bot
added
arrow
| @@ -57,125 +56,3 @@ cargo run --example builders | |||
| cargo run --example dynamic_types | |||
| cargo run --example read_csv | |||
| ``` | |||
|
|
|||
There was a problem hiding this comment.
moved to contributing
Codecov Report
@@ Coverage Diff @@
## master #536 +/- ##
=======================================
Coverage 82.60% 82.60%
=======================================
Files 167 167
Lines 45984 45984
=======================================
Hits 37984 37984
Misses 8000 8000 Continue to review full report at Codecov.
|
| @@ -17,61 +17,122 @@ | |||
| under the License. | |||
| --> | |||
|
|
|||
| # How to contribute to Apache Arrow | |||
There was a problem hiding this comment.
This file was still a copy of the main arrow repo's contributing guidelines. I have replaced the content.
It might be worth spending some time breaking out the contributing guide from the developer guide but perhaps we can do that as a follow on PR. At least after this PR the content is no longer inaccurate / refers to JIRA, etc
alamb
force-pushed
the
alamb/update_readmes
branch
from
969af49
to
f850aca
Compare
|
Unless anyone objects, I plan to merge this in tomorrow, and possibly will try and split out developer specific stuff from more general contributing guidelines |
Which issue does this PR close?
Fixes #463
You can see the rendered versions of this markdown in: https://github.com/alamb/arrow-rs/tree/alamb/update_readmes
Rationale for this change
The READMEs needed some TLC and had intermixed user facing and contributor facing content
What changes are included in this PR?
Since README.md content appears in crates.io (e.g. the arrow page, move all contributing content to CONTRIBUTING.md to mirror the main arrow repo
Update the README.md content to be focused on the "explain to a casual user what this crate is and how to use it"
Are there any user-facing changes?
(Hopefully) better docs!