diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 43f87ad282..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,30 +0,0 @@ - - -# Contributing -We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [github.com/apache/parquet-mr](https://github.com/apache/parquet-mr) repository. If you've previously forked Parquet from its old location, you will need to add a remote or update your origin remote to https://github.com/apache/parquet-mr.git -Here are a few tips to get your contribution in: - - 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 [Parquet Project JIRA](https://issues.apache.org/jira/browse/PARQUET). - 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/parquet-mr/pull/117). - 4. Make sure that your code passes the unit tests. You can run the tests with `mvn test` in the root directory. - 5. Add new unit tests for your code. - -If you’d like to report a bug but don’t have time to fix it, you can still post it to our [issue tracker](https://issues.apache.org/jira/browse/PARQUET), or email the mailing list (dev@parquet.apache.org). diff --git a/DISCLAIMER b/DISCLAIMER deleted file mode 100644 index 72eef1918b..0000000000 --- a/DISCLAIMER +++ /dev/null @@ -1,8 +0,0 @@ -Apache Parquet is an effort undergoing incubation at The Apache Software -Foundation (ASF), sponsored by The Apache Incubator. Incubation is required of -all newly accepted projects until a further review indicates that the -infrastructure, communications, and decision making process have stabilized in -a manner consistent with other successful ASF projects. While incubation status -is not necessarily a reflection of the completeness or stability of the code, -it does indicate that the project has yet to be fully endorsed by the ASF. - diff --git a/README.md b/README.md index d6c1713fec..a34e396714 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ ~ under the License. --> -Parquet MR [![Build Status](https://travis-ci.org/apache/incubator-parquet-mr.svg?branch=master)](http://travis-ci.org/apache/incubator-parquet-mr) +Parquet MR [![Build Status](https://travis-ci.org/apache/parquet-mr.svg?branch=master)](http://travis-ci.org/apache/parquet-mr) ====== Parquet-MR contains the java implementation of the [Parquet format](https://github.com/apache/parquet-format). @@ -144,93 +144,61 @@ mvn test to build the jars: mvn package -The build runs in [Travis CI](http://travis-ci.org/Parquet/parquet-mr): -[![Build Status](https://secure.travis-ci.org/Parquet/parquet-mr.png?branch=master)](http://travis-ci.org/Parquet/parquet-mr) +The build runs in [Travis CI](http://travis-ci.org/apache/parquet-mr): +[![Build Status](https://travis-ci.org/apache/parquet-mr.svg?branch=master)](http://travis-ci.org/apache/parquet-mr) ## Add Parquet as a dependency in Maven - -### Snapshot releases -* [apis documentation](http://parquet.io/parquet-mr/site/1.0.0-SNAPSHOT/apidocs/index.html) -* maven dependency: +The current release is version `1.7.0` ```xml - - - sonatype-nexus-snapshots - https://oss.sonatype.org/content/repositories/snapshots - - false - - - true - - - - com.twitter + org.apache.parquet parquet-common - 1.0.0-SNAPSHOT + 1.7.0 - com.twitter + org.apache.parquet parquet-encoding - 1.0.0-SNAPSHOT + 1.7.0 - com.twitter + org.apache.parquet parquet-column - 1.0.0-SNAPSHOT + 1.7.0 - com.twitter + org.apache.parquet parquet-hadoop - 1.0.0-SNAPSHOT + 1.7.0 ``` -### Official releases -#### 1.0.0 -* [apis documentation](http://parquet.io/parquet-mr/site/1.0.0/apidocs/index.html) -* maven dependency: +### How To Contribute -```xml - - - com.twitter - parquet-common - 1.0.0 - - - com.twitter - parquet-encoding - 1.0.0 - - - com.twitter - parquet-column - 1.0.0 - - - com.twitter - parquet-hadoop - 1.0.0 - - -``` +We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [github.com/apache/parquet-mr](https://github.com/apache/parquet-mr) repository. If you've previously forked Parquet from its old location, you will need to add a remote or update your origin remote to https://github.com/apache/parquet-mr.git -### How To Contribute +If you are looking for some ideas on what to contribute, check out jira issues for this project labeled ["pick-me-up"](https://issues.apache.org/jira/browse/PARQUET-5?jql=project%20%3D%20PARQUET%20and%20labels%20%3D%20pick-me-up%20and%20status%20%3D%20open). +Comment on the issue and/or contact [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-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 to our [issue tracker](https://issues.apache.org/jira/browse/PARQUET), or email the mailing list [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-dev/) + +To contribute a patch: -If you are looking for some ideas on what to contribute, check out GitHub issues for this project labeled ["Pick me up!"](https://github.com/apache/parquet-mr/issues?labels=pick+me+up%21&state=open). -Comment on the issue and/or contact [the parquet-dev group](https://groups.google.com/d/forum/parquet-dev) with your questions and ideas. + 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 [Parquet Project JIRA](https://issues.apache.org/jira/browse/PARQUET). + 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/parquet-mr/pull/117). + 4. Make sure that your code passes the unit tests. You can run the tests with `mvn test` in the root directory. + 5. Add new unit tests for your code. We tend to do fairly close readings of pull requests, and you may get a lot of comments. Some common issues that are not code structure related, but still important: -* Please make sure to add the license headers to all new files. You can do this automatically by using the `mvn license:format` command. -* Use 2 spaces for whitespace. Not tabs, not 4 spaces. The number of the spacing shall be 2. -* Give your operators some room. Not `a+b` but `a + b` and not `foo(int a,int b)` but `foo(int a, int b)`. -* Generally speaking, stick to the [Sun Java Code Conventions](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html) -* Make sure tests pass! + * Use 2 spaces for whitespace. Not tabs, not 4 spaces. The number of the spacing shall be 2. + * Give your operators some room. Not `a+b` but `a + b` and not `foo(int a,int b)` but `foo(int a, int b)`. + * Generally speaking, stick to the [Sun Java Code Conventions](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html) + * Make sure tests pass! + +Thank you for getting involved! ## Authors and contributors @@ -247,15 +215,17 @@ We tend to do fairly close readings of pull requests, and you may get a lot of c ## Code of Conduct -We hold ourselves and the Parquet developer community to a code of conduct as described by [Twitter OSS](https://engineering.twitter.com/opensource): . +We hold ourselves and the Parquet developer community to two codes of conduct: + 1. [The Apache Software Foundation Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) + 2. [The Twitter OSS Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md) ## Discussions -* google group https://groups.google.com/d/forum/parquet-dev -* the group email address: parquet-dev@googlegroups.com +* Mailing list: [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-dev/) +* Bug trackter: [jira](https://issues.apache.org/jira/browse/PARQUET) +* Discussions also take place in github pull requests ## License -Copyright 2012-2013 Twitter, Inc. - Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 +See also: diff --git a/dev/README.md b/dev/README.md index 4a4b18e446..25dd33692c 100644 --- a/dev/README.md +++ b/dev/README.md @@ -26,8 +26,8 @@ Merging a pull request requires being a committer on the project. * How to merge a Pull request: have an apache and apache-github remote setup ``` -git remote add apache-github git@github.com:apache/incubator-parquet-mr.git -git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-parquet-mr.git +git remote add apache-github git@github.com:apache/parquet-mr.git +git remote add apache https://git-wip-us.apache.org/repos/asf/parquet-mr.git ``` run the following command ``` @@ -42,19 +42,19 @@ example output: ``` Which pull request would you like to merge? (e.g. 34): ``` -Type the pull request number (from https://github.com/apache/incubator-parquet-mr/pulls) and hit enter. +Type the pull request number (from https://github.com/apache/parquet-mr/pulls) and hit enter. ``` === Pull Request #X === title Blah Blah Blah source repo/branch target master -url https://api.github.com/repos/apache/incubator-parquet-mr/pulls/X +url https://api.github.com/repos/apache/parquet-mr/pulls/X Proceed with merging pull request #3? (y/n): ``` If this looks good, type y and hit enter. ``` -From git-wip-us.apache.org:/repos/asf/incubator-parquet-mr.git +From git-wip-us.apache.org:/repos/asf/parquet-mr.git * [new branch] master -> PR_TOOL_MERGE_PR_3_MASTER Switched to branch 'PR_TOOL_MERGE_PR_3_MASTER' @@ -68,7 +68,7 @@ Delta compression using up to 4 threads. Compressing objects: 100% (26/26), done. Writing objects: 100% (36/36), 5.32 KiB, done. Total 36 (delta 17), reused 0 (delta 0) -To git-wip-us.apache.org:/repos/asf/incubator-parquet-mr.git +To git-wip-us.apache.org:/repos/asf/parquet-mr.git b767ac4..485658a PR_TOOL_MERGE_PR_X_MASTER -> master Restoring head pointer to b767ac4e Note: checking out 'b767ac4e'.