Collaborating on Github

Getting Started with Github

Here is the workflow for using Github for the non-committers who are developing their features on GitHub:

1. Create an account on GitHub.
   See Setting Up Git
2. Fork the Apache Repo:
3. Go to https://github.com/apache/incubator-cloudstack.
4. Click Fork.
   See Fork a Repo
5. Clone your fork:
   git clone https://github.com/<username>/incubator-cloudstack.git
6. Configure remote:
   git remote add upstream https://github.com/apache/incubator-cloudstack
7. When your fork needs to get the latest from it's parent fork (gh:apache/cloudstack). And you should do this periodically (read:daily) for a long running feature
   1. git fetch upstream
   2. git checkout <feature-branch> #This is your local feature branch likely mirroring a remote feature-branch at origin
   3. git merge upstream/<feature-branch> (or git merge --no-ff to preserve git branching history)

When working on github which is not what committers will be looking at often: it's best to alert the lists so people will be aware of the incremental commits you make and can review your work periodically and/or as and when you request for it.

It is also best to work on feature branches rather than working directly on master even in your private fork.  When the patch is ready for submission push the squashed patch through reviewboard. If the patch is sizeable and touches many projects in the repo, best to break it down into smaller chunks for easier and quicker review of multiple committers.

Holler for help on the lists if you're stuck and ever need help. 

Submitting Patches

When you have some code to contribute, please follow these instructions on submitting a patch to review board.

CloudStack currently doesn't utilize Github pull requests.