Repositories
- Apache HAWQ git repository (https://git-wip-us.apache.org/repos/asf/incubator-hawq.git) : Apache internal git repo.
- Github Apache HAWQ mirror (https://github.com/apache/incubator-hawq.git) : This repo is synced automatically from Apache HAWQ git repo.
Branching
The Gitflow branching model is used. Please reference the following links for details:
https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow (easy to understand)
http://nvie.com/posts/a-successful-git-branching-model/ (original one)
HAWQ issue tracking
HAWQ uses Jira for issue tracking. All changes are discussed and reviewed in Jira before commit.
Coding conventions
HAWQ follows the coding conventions of postgresql: http://www.postgresql.org/docs/9.1/static/source.html
Contribution process (for contributors)
The overall contribution process is to fork a repo from the github mirror repo, and work on the forked repo for any changes. Do code review by creating pull requests.
- Fork the apache github mirror incubator-hawq repo; you will work on your own repo for new features or bug fixes
- Clone your own repository to local
- Add the apache github mirror as “upstream”
# git remote add upstream https://github.com/apache/incubator-hawq.git
- Fetch “upstream” repository
# git fetch upstream
- (optional) Add local master branch
# git checkout origin/master -b master
- Create a feature branch “feature-awesome” to work on
# git checkout -b feature-awesome develop
- Make changes and commit to local. Please format commit message as follows and feel free to add additional comments.
<jira ticket number>. <Commit Message>
Example: HAWQ-1002. Add awesome feature - Push it to your github repo
# git push --set-upstream origin feature-awesome (or git push origin feature-hawq-123) - Now you can create pull requests on github for code review.
Commit process (for committers)
The overall commit process it to review the pull request. If the change passes code review, get the patch and commit it to Apache git repo.
Clone the apache repository
# git clone https://git-wip-us.apache.org/repos/asf/incubator-hawq.gitAdd remote github mirror repository
# git remote add github https://github.com/apache/incubator-hawq.gitGet the pull request
# git fetch github pull/2/head:feature_awesomeCheckout develop branch
# git checkout developMerge the patch
# git merge feature_awesomeRun unit tests (more in future before committing to “develop” branch)
# make installcheck_goodPush to apache repo (note: all commits needs an Apache JIRA)
# git push originDelete the feature branch
# git branch -d feature_awesome