Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 2.42 KB

contributing.md

File metadata and controls

64 lines (49 loc) · 2.42 KB
Raw

How to contribute

PolarDB for PostgreSQL is an open source product from PostgreSQL and other open source projects. Our main target is to create a larger community for PostgreSQL. Contributors are welcome 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.

Before contributing

  • read and follow our Code of Conduct
  • sign CLA of PolarDB for PostgreSQL: Please download PolarDB CLA. Follow the instructions to sign it.

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

  • create your own Github branch by forking alibaba/PolarDB-for-PostgreSQL
  • checkout readme for how to start PolarDB from source code; more deployment information can be found in deployment
  • push changes to your personal fork and make sure they follow our coding style
  • run basic testing, such as make check or make check-world-dma, see regress
  • create a PR with a detail description, if commit messages do not express themselves
  • submit PR for review and address all feedbacks
  • wait for merging (done by committers)

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

An Example of Submitting Code Change to PolarDB

fork your own branch

On PolarDB Github page, Click fork button to create your own PolarDB repo

create local repository

git clone https://github.com/your_github/PolarDB-for-PostgreSQL.git

create a dev branch (named as test-github)

git branch test-github

make changes and commit locally

git status
git add files-to-change
git commit -m "modification for test-github"

rebase on master and commit to remote repo

git checkout master
git pull
git checkout test-github
git rebase master
-- resolve conflict, compile and test --
git push origin test-github

create a PR

click New pull request or Compare & pull request button, choose to compare branches alibaba/PolarDB-for-PostgreSQL and your_github/test-github, and write PR description.

Address reviewers' comments

resolve all problems raised by reviewers and update PR

Merge

It is done by PolarDB committers.

Copyright © Alibaba Group, Inc.