Skip to content

Latest commit

 

History

History
122 lines (95 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

122 lines (95 loc) · 3.4 KB
Raw

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

Mac

  1. Install Xcode
  2. Install packages with Homebrew
brew update
brew install git postgresql
  1. Get, build, and test the code
git clone https://github.com/citusdata/citus.git

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

Debian-based Linux (Ubuntu, Debian)

  1. Install build dependencies
echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" | \
     sudo tee /etc/apt/sources.list.d/pgdg.list
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | \
     sudo apt-key add -
sudo apt-get update

sudo apt-get install -y postgresql-server-dev-9.6 postgresql-9.6 \
                        libedit-dev libselinux1-dev libxslt-dev  \
                        libpam0g-dev git flex make libssl-dev    \
                        libkrb5-dev
  1. Get, build, and test the code
git clone https://github.com/citusdata/citus.git
cd citus
./configure
make
sudo make install
cd src/test/regress
make check

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

  1. Find the PostgreSQL 9.6 RPM URL for your repo at yum.postgresql.org
  2. Register its contents with Yum:
sudo yum install -y <url>
  1. Install build dependencies
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 https://github.com/citusdata/citus.git
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.

# 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 https://github.com/uncrustify/uncrustify.git
pushd uncrustify
./configure
sudo make install
popd

git clone https://github.com/citusdata/tools.git
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.