From 462e766e5321246649824605e3c8d5b3ad87fe97 Mon Sep 17 00:00:00 2001 From: Wes McKinney Date: Thu, 5 Oct 2017 11:16:47 -0400 Subject: [PATCH] Add CONTRIBUTING.md to .github special directory Change-Id: I1464f79476c45d3985de9ee5186dae87e3a44f77 --- .github/CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000000..740f85320c4 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,71 @@ + + +## Contributing to Apache Arrow + +There are many ways to contribute to Apache Arrow: + +* Contributing code (we call them "patches") +* Writing documentation (another form of code, in a way) +* Participating in discussions on JIRA or the mailing list +* Helping users of the libraries + +## Reporting bugs and asking questions + +We support GitHub issues as a lightweight way to ask questions and engage with +the Arrow developer community. We use [JIRA][3] for maintaining a queue of +development work and as the public record for work on the project. So, feel +free to open GitHub issues, but bugs and feature requests will eventually need +to end up in JIRA, either before or after completing a pull request. + +## How to contribute patches + +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