Contributing to Citus

We're happy you want to contribute! You can help us in different ways:

  • Open an issue with suggestions for improvements
  • Fork this repository and submit a pull request

Before accepting any code contributions we ask that Citus contributors sign a Contributor License Agreement (CLA). For an explanation of why we ask this as well as instructions for how to proceed, see the Citus CLA.

Getting and building


  1. Install Xcode
  2. Install packages with Homebrew

    bash brew update brew install git postgresql

  3. Get, build, and test the code

    ```bash git clone

    cd citus ./configure make make install cd src/test/regress make check ```

Debian-based Linux (Ubuntu, Debian)

  1. Install build dependencies

    ```bash echo "deb $(lsb_release -cs)-pgdg main" | \ sudo tee /etc/apt/sources.list.d/pgdg.list wget --quiet -O - | \ sudo apt-key add - sudo apt-get update

    sudo apt-get install -y postgresql-server-dev-10 postgresql-10 \ libedit-dev libselinux1-dev libxslt-dev \ libpam0g-dev git flex make libssl-dev \ libkrb5-dev ```

  2. Get, build, and test the code

    bash git clone cd citus ./configure make sudo make install cd src/test/regress make check

Red Hat-based Linux (RHEL, CentOS, Fedora)

  1. Find the PostgreSQL 10 RPM URL for your repo at
  2. Register its contents with Yum:

    bash sudo yum install -y <url>

  3. Install build dependencies

    ```bash sudo yum update -y sudo yum groupinstall -y 'Development Tools' sudo yum install -y postgresql96-devel postgresql96-server \ libxml2-devel libxslt-devel openssl-devel \ pam-devel readline-devel git

    git clone cd citus PG_CONFIG=/usr/pgsql-9.6/bin/pg_config ./configure make sudo make install cd src/test/regress make check ```

Following our coding conventions

Travis will automatically reject any PRs which do not follow our coding conventions, it won't even run tests! The easiest way to ensure your PR adheres to those conventions is to use the citus_indent tool.

```bash # Ubuntu does have uncrustify in the package manager however it's an older # version which doesn't work with our citus-style.cfg file. We require version # 0.60 or greater. If your package manager has a more recent version of uncrustify # feel free to use that instead of installing from source git clone --branch uncrustify-0.60 pushd uncrustify ./configure sudo make install popd

git clone pushd tools/uncrustify make install popd ```

Once you've done that, you can run the citus_indent command to recursively check and correct the style of any source files in the current directory. You can also run make reindent from within the Citus repo to correct the style of all source files in the repository.