quinnj commented on a change in pull request #9121:
URL: https://github.com/apache/arrow/pull/9121#discussion_r554149673



##########
File path: julia/Arrow/README.md
##########
@@ -1,13 +1,38 @@
 # Arrow
 
-[![Build 
Status](https://travis-ci.com/JuliaData/Arrow.jl.svg?branch=master)](https://travis-ci.com/JuliaData/Arrow.jl.svg?branch=master)
+[![docs](https://img.shields.io/badge/docs-latest-blue&logo=julia)](https://arrow.juliadata.org/dev/)
+[![CI](https://github.com/JuliaData/Arrow.jl/workflows/CI/badge.svg)](https://github.com/JuliaData/Arrow.jl/actions?query=workflow%3ACI)
 
[![codecov](https://codecov.io/gh/JuliaData/Arrow.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaData/Arrow.jl)
 
+[![deps](https://juliahub.com/docs/Arrow/deps.svg)](https://juliahub.com/ui/Packages/Arrow/QnF3w?t=2)
+[![version](https://juliahub.com/docs/Arrow/version.svg)](https://juliahub.com/ui/Packages/Arrow/QnF3w)
+[![pkgeval](https://juliahub.com/docs/Arrow/pkgeval.svg)](https://juliahub.com/ui/Packages/Arrow/QnF3w)
+
 This is a pure Julia implementation of the [Apache 
Arrow](https://arrow.apache.org) data standard.  This package provides Julia 
`AbstractVector` objects for
 referencing data that conforms to the Arrow standard.  This allows users to 
seamlessly interface Arrow formatted data with a great deal of existing Julia 
code.
 
 Please see this 
[document](https://arrow.apache.org/docs/format/Columnar.html#physical-memory-layout)
 for a description of the Arrow memory layout.
 
+## Installation
+
+The package can be installed by typing in the following in a Julia REPL:
+
+```julia
+julia> using Pkg; Pkg.add(url="https://github.com/apache/arrow";, 
subdir="julia/Arrow.jl")
+```
+
+or to use the non-official-apache code that will sometimes include bugfix 
patches between apache releases, you can do:
+
+```julia
+julia> using Pkg; Pkg.add("Arrow")
+```
+
+## Difference between this code and the JuliaData/Arrow.jl repository
+
+This code is officially part of the apache/arrow repository and as such 
follows the regulated release cadence of the entire project, following standard 
community
+voting protocols. The JuliaData/Arrow.jl repository can be viewed as a sort of 
"dev" or "latest" branch of this code that may release more frequently, but 
without following
+official apache release guidelines. The two repositories are synced, however, 
so any bugfix patches in JuliaData will be upstreamed to apache/arrow for each 
release.

Review comment:
       Well, we currently do a bugfix release after every bugfix commit in 
JuliaData. There are also the complications with apache/arrow CI right now that 
make it pretty difficult to develop against. Another point is that Julia 
packages have historically been their own github repos, and so users naturally 
go to the github repo to file issues or make PRs. There's much lower friction, 
institutionally, to do that at JuliaData and then ensure changes get moved up 
here.
   
   I do think it's something we can transition over time though, with effort. I 
think the Julia ecosystem will become easier to allow a package to live in a 
monorepo and dev efforts can be encouraged here.




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

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to