Code Contributing

PolarDB for PostgreSQL is an open source project based on PostgreSQL and other open source projects. Our main target is to create a larger community of PostgreSQL. Contributors are welcomed to submit their code and ideas. In a long run, we hope this project can be managed by developers from both inside and outside Alibaba Cloud.

Branch Description and Management

POLARDB_15_STABLE is the stable branch of PolarDB-PG

Before Contributing

Sign the CLAopen in new window of PolarDB for PostgreSQL

Contributing

Here is a checklist to prepare and submit your PR (pull request):

Create your own Github repository copy by forking ApsaraDB/PolarDB-for-PostgreSQL.
Checkout documentations Advanced Deployment for how to hack PolarDB-PG.
Run make stylecheck to format your code, and push changes to your personal fork.
Edit detailed commit message, and create a PR to upstream.
Wait for all CI checks to pass.
Wait for review and address all feedbacks.
Wait for merging.

An Example of Submitting Code Change

Let's use an example to walk through the list.

Fork Your Own Repository

On GitHub repository of PolarDB for PostgreSQLopen in new window, Click fork button to create your own PolarDB repository.

Create Local Repository

git clone https://github.com/<your-github>/PolarDB-for-PostgreSQL.git

Create a Local Development Branch

Check out a new development branch from the stable branch POLARDB_15_STABLE. Suppose your branch is named as dev:

git checkout POLARDB_15_STABLE
git checkout -b dev

Make Changes and Commit Locally

git status
git add <files-to-change>
git commit -m "modification for dev"

Rebase and Commit to Remote Repository

Click Fetch upstream on your own repository page to make sure your development branch is up do date with upstream. Then pull the latest commits on stable branch to your local repository.

git checkout POLARDB_15_STABLE
git pull

Then, rebase your development branch to the stable branch, and resolve conflicts:

git checkout dev
git rebase POLARDB_15_STABLE
-- resolve conflict --
git push -f dev