You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/07/10 11:17:54 UTC

[GitHub] [arrow-rs] alamb opened a new pull request #536: Clean up README.md in advance of the 5.0 release

alamb opened a new pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536


   # Which issue does this PR close?
   
   Fixes https://github.com/apache/arrow-rs/issues/463
   
   
   # 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?
   
   1. Since README.md content appears in crates.io (e.g. the [arrow](https://crates.io/crates/arrow) page, move all contributing content to CONTRIBUTING.md to mirror the [main arrow repo](https://github.com/apache/arrow/blob/master/CONTRIBUTING.md)
   
   2. 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!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb commented on pull request #536: Clean up README.md in advance of the 5.0 release

Posted by GitBox <gi...@apache.org>.
alamb commented on pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536#issuecomment-878550232


   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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb merged pull request #536: Clean up README.md in advance of the 5.0 release

Posted by GitBox <gi...@apache.org>.
alamb merged pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb commented on a change in pull request #536: Clean up README.md in advance of the 5.0 release

Posted by GitBox <gi...@apache.org>.
alamb commented on a change in pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536#discussion_r667328356



##########
File path: CONTRIBUTING.md
##########
@@ -17,61 +17,122 @@
   under the License.
 -->
 
-# How to contribute to Apache Arrow

Review 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




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] codecov-commenter commented on pull request #536: Clean up README.md in advance of the 5.0 release

Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536#issuecomment-877625102


   # [Codecov](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
   > Merging [#536](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (969af49) into [master](https://codecov.io/gh/apache/arrow-rs/commit/f1fb2b11bbd6350365de010d3e1d676a27602d3a?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (f1fb2b1) will **not change** coverage.
   > The diff coverage is `n/a`.
   
   [![Impacted file tree graph](https://codecov.io/gh/apache/arrow-rs/pull/536/graphs/tree.svg?width=650&height=150&src=pr&token=pq9V9qWZ1N&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
   
   ```diff
   @@           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](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation).
   > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
   > `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
   > Powered by [Codecov](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation). Last update [f1fb2b1...969af49](https://codecov.io/gh/apache/arrow-rs/pull/536?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation).
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb commented on a change in pull request #536: Clean up README.md in advance of the 5.0 release

Posted by GitBox <gi...@apache.org>.
alamb commented on a change in pull request #536:
URL: https://github.com/apache/arrow-rs/pull/536#discussion_r667327974



##########
File path: arrow/README.md
##########
@@ -57,125 +56,3 @@ cargo run --example builders
 cargo run --example dynamic_types
 cargo run --example read_csv
 ```
-

Review comment:
       moved to contributing




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org