arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject arrow git commit: ARROW-724: Add How to Contribute section to README
Date Sun, 09 Apr 2017 17:52:25 GMT
Repository: arrow
Updated Branches:
  refs/heads/master 359110370 -> b0e3122b9

ARROW-724: Add How to Contribute section to README

Author: Wes McKinney <>

Closes #504 from wesm/ARROW-724 and squashes the following commits:

c1e07b6 [Wes McKinney] Typo
3a6083c [Wes McKinney] Add how to contribute section modifed from parquet-mr


Branch: refs/heads/master
Commit: b0e3122b904924dc86cf470edfa726e38bd14f83
Parents: 3591103
Author: Wes McKinney <>
Authored: Sun Apr 9 13:52:20 2017 -0400
Committer: Wes McKinney <>
Committed: Sun Apr 9 13:52:20 2017 -0400

---------------------------------------------------------------------- | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)
diff --git a/ b/
index 1eb3f86..2790895 100644
--- a/
+++ b/
@@ -25,7 +25,7 @@
-#### Powering Columnar In-Memory Analytics
+### Powering Columnar In-Memory Analytics
 Arrow is a set of technologies that enable big-data systems to process and move data fast.
@@ -39,7 +39,7 @@ Initial implementations include:
 Arrow is an [Apache Software Foundation]( project. Learn more at
-#### What's in the Arrow libraries?
+### What's in the Arrow libraries?
 The reference Arrow implementations contain a number of distinct software
@@ -59,12 +59,7 @@ components:
 - Conversions to and from other in-memory data structures (e.g. Python's pandas
-#### Getting involved
-Right now the primary audience for Apache Arrow are the developers of data
-systems; most people will use Apache Arrow indirectly through systems that use
-it for internal data handling and interoperating with other Arrow-enabled
+### Getting involved
 Even if you do not plan to contribute to Apache Arrow itself or Arrow
 integrations in other projects, we'd be happy to have you involved:
@@ -76,6 +71,38 @@ integrations in other projects, we'd be happy to have you involved:
 - [Learn the format][2]
 - Contribute code to one of the reference implementations
+### How to Contribute
+We prefer to receive contributions in the form of GitHub pull requests. Please
+send pull requests against the [][4] repository.
+If you are looking for some ideas on what to contribute, check out the [JIRA
+issues][3] for the Apache Arrow project. Comment on the issue and/or contact
+with your questions and ideas.
+If you’d like to report a bug but don’t have time to fix it, you can still post
+it on JIRA, or email the mailing list
+To contribute a patch:
+1. Break your work into small, single-purpose patches if possible. It’s much
+harder to merge in a large change with a lot of disjoint features.
+2. Create a JIRA for your patch on the [Arrow Project
+3. Submit the patch as a GitHub pull request against the master branch. For a
+tutorial, see the GitHub guides on forking a repo and sending a pull
+request. Prefix your pull request name with the JIRA name (ex:
+4. Make sure that your code passes the unit tests. You can find instructions
+how to run the unit tests for each Arrow component in its respective README
+5. Add new unit tests for your code.
+Thank you in advance for your contributions!
\ No newline at end of file

View raw message