Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

82 lines (60 loc) · 2.43 KB
Raw

Contributing to pgcopydb

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

  • Open an issue with suggestions for improvements, potential bugs, etc.
  • Fork this repository and submit a pull request

Building from source code

Follow the relevant docs at our documentation.

Following our coding conventions

CI pipeline will automatically reject any PRs which do not follow our coding conventions. The easiest way to ensure your PR adheres to those conventions is to use the citus_indent tool. This tool uses uncrustify under the hood.

# On debian, run the following to install uncrustify.
# On other distros, use your package manager for a similar command.
sudo apt-get install uncrustify

# Install citus_indent
git clone https://github.com/citusdata/tools.git
cd tools
make uncrustify/.install

Once you've done that, you can run the make indent command from the top directory to recursively check and correct the style of any source files in the current directory. Under the hood, make indent will run citus_indent for you.

You can also run the following in the directory of this repository to automatically format all the files that you have changed before committing:

cat > .git/hooks/pre-commit << __EOF__
#!/bin/bash
citus_indent --check --diff || { citus_indent --diff; exit 1; }
__EOF__
chmod +x .git/hooks/pre-commit

Running tests

pgcopydb uses docker containers to create test environments. Each test lives under a separate directory under tests/ directory at the top directory of the project.

You can run the following commands to run our tests:

# To run all the tests
make tests

# To run a single test, e.g. pagila
make tests/pagila

Documentation

User-facing documentation is published on pgcopydb.readthedocs.io. When adding a new feature, function, or setting, you are expected to add relevant documentation change in your pull request.

If you changed the help output of a pgcopydb command, you are expected to update the relevant pieces of our documentation. This can be done automatically by running the following command:

make update-docs

This command will update the relevant documentation templates according to your latest code changes.