How To Contribute

Pull Requests

We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the repository. If you’ve previously forked Parquet from its old location, you will need to add a remote or update your origin remote to 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.
  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 run the tests with mvn test in the root directory.
  5. Add new unit tests for your code.
  6. All Pull Requests are tested automatically on GitHub Actions. TravisCI is also used to run the tests on ARM64 CPU architecture

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, or email the mailing list (


Merging a pull request requires being a comitter on the project.

How to merge a Pull request (have an apache and github-apache remote setup):

git remote add github-apache
git remote add apache

run the following command


example output:

Which pull request would you like to merge? (e.g. 34):

Type the pull request number (from and hit enter.

=== Pull Request #X ===
title   Blah Blah Blah
source  repo/branch
target  master

Proceed with merging pull request #3? (y/n): 

If this looks good, type y and hit enter.

* [new branch]      master     -> PR_TOOL_MERGE_PR_3_MASTER
Switched to branch 'PR_TOOL_MERGE_PR_3_MASTER'

Merge complete (local ref PR_TOOL_MERGE_PR_3_MASTER). Push to apache? (y/n):

A local branch with the merge has been created. Type y and hit enter to push it to apache master

Counting objects: 67, done.
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)
   b767ac4..485658a  PR_TOOL_MERGE_PR_X_MASTER -> master
Restoring head pointer to b767ac4e
Note: checking out 'b767ac4e'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:

  git checkout -b new_branch_name

HEAD is now at b767ac4... Update
Deleting local branch PR_TOOL_MERGE_PR_X
Deleting local branch PR_TOOL_MERGE_PR_X_MASTER
Pull request #X merged!
Merge hash: 485658a5

Would you like to pick 485658a5 into another branch? (y/n):

For now just say n as we have 1 branch


We use middleman to generate the website content from markdown and other dynamic templates. The following steps assume you have a working ruby environment setup

gem install bundler
bundle install

Cloning the website

Cloning the website from git:

git clone

Make changes in source/

Make any changes in the source directory:

cd parquet-site/source/

Generating the website

To generate the static wesbite for Apache Parquet run the following commands at the root site directory:

bundle exec middleman build
git add .
git commit -m 'made changes to the site'
git push

(git push can only be done by a committer. If you are not a committer then you may create a pull reqest from your forked repository and let a committer push your changes.)

Live Development

Live development of the site enables automatic reload when changes are saved. To enable run the following command and then open a browser and navigate to http://localhost:4567

bundle exec middleman 

Publishing the Site

The website uses gitpubsub. The output folder contains the websites content and when committed to the git repository it will be automatically deployed to the live site.