Revision as of 21:48, 1 November 2013

Before You Begin

The configuration of the Solum StackForge Repo requires that you have an OpenStack CLA. For information about how prepare for contribution, please consult the How To Contribute wiki page.

Learn About Gerrit

Be sure to read the Gerrit Workflow wiki page for information about how to submit your commit for review so it can be merged into the Solum code base.

Setting up your git review settings

 git config --global user.name "Firstname Lastname"
 git config --global user.email "your_email@youremail.com"

To check your git configuration:

 git config --list

Installing git-review

On Ubuntu, MacOSx, or most other Unix-like systems, it is as simple as:

 pip install git-review

There are other installation options detailed in the Installation Instructions. You can now check out the Solum code and begin working on it:

Your first commit

Set up your local branch

 git clone git://git.openstack.org/stackforge/solum
 cd solum
 git checkout -b [branch name]
 git review -s

Modify CONTRIBUTORS file

Open the file for edit, add your name and email address to the list and save the file.

 vi CONTRIBUTORS.rst

Create a draft review

 git add CONTRIBUTORS.rst
 git commit -a
 git review -v --draft

At this point if all has been successful it should provide you with a review.openstack.org URL to track your change. Follow that URL and "Sign In" and you should see your change.

Write some awesome code

At this point can write your code and push it up to your review. You will want to amend your changes to the original commit ( reduce noise )

 git add <list of files you added/changed>
 git commit --amend 
 git review -v

Once you are happy with your code and want it to be reviewed you want to convert it from a Draft. "Sign In" at https://review.openstack.org/ and after verifying the review yourself hit the "Publish" button on the page.

Upon approval of the review your code will be automatically merged.