arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From w...@apache.org
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 <wes.mckinney@twosigma.com>

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


Project: http://git-wip-us.apache.org/repos/asf/arrow/repo
Commit: http://git-wip-us.apache.org/repos/asf/arrow/commit/b0e3122b
Tree: http://git-wip-us.apache.org/repos/asf/arrow/tree/b0e3122b
Diff: http://git-wip-us.apache.org/repos/asf/arrow/diff/b0e3122b

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

----------------------------------------------------------------------
 README.md | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/arrow/blob/b0e3122b/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 1eb3f86..2790895 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
   </tr>
 </table>
 
-#### 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](www.apache.org) project. Learn more at
 [arrow.apache.org](http://arrow.apache.org).
 
-#### What's in the Arrow libraries?
+### What's in the Arrow libraries?
 
 The reference Arrow implementations contain a number of distinct software
 components:
@@ -59,12 +59,7 @@ components:
 - Conversions to and from other in-memory data structures (e.g. Python's pandas
   library)
 
-#### 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
-systems.
+### 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 [github.com/apache/arrow][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
+[dev@arrow.apache.org](http://mail-archives.apache.org/mod_mbox/arrow-dev/)
+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
+[dev@arrow.apache.org](http://mail-archives.apache.org/mod_mbox/arrow-dev/)
+
+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
+JIRA](https://issues.apache.org/jira/browse/ARROW).
+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:
+https://github.com/apache/arrow/pull/240).
+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
+file.
+5. Add new unit tests for your code.
+
+Thank you in advance for your contributions!
+
 [1]: mailto:dev-subscribe@arrow.apache.org
 [2]: https://github.com/apache/arrow/tree/master/format
 [3]: https://issues.apache.org/jira/browse/ARROW
+[4]: https://github.com/apache/arrow
\ No newline at end of file


Mime
View raw message