Jump to: navigation, search

Difference between revisions of "Solum/Contributing"

Line 1: Line 1:
 +
__TOC__
  
 +
= Before you Begin =
 +
The configuration of the [https://github.com/stackforge/solum Solum StackForge Repo] requires that you have an [[How_To_Contribute#Contributors_License_Agreement|OpenStack CLA]].
 +
For information about how prepare for contribution, please consult the [[How_To_Contribute |How To Contribute]] wiki page.
  
The configuration of the [https://github.com/stackforge/solum Solum StackForge Repo] requires that you have an [[How_To_Contribute#Contributors_License_Agreement|OpenStack CLA]]. For information about how prepare for contribution, please consult the [[How_To_Contribute |How To Contribute]] wiki page.
+
== Learn about Gerrit ==
 
 
 
Be sure to read the [[Gerrit_Workflow|Gerrit Workflow]] wiki page for information about how to submit your commit for review so it can be merged into the Solum code base.
 
Be sure to read the [[Gerrit_Workflow|Gerrit Workflow]] wiki page for information about how to submit your commit for review so it can be merged into the Solum code base.
  
Quick Start:
+
== Setting up your git review settings ==
 
   git config --global user.name "Firstname Lastname"
 
   git config --global user.name "Firstname Lastname"
 
   git config --global user.email "your_email@youremail.com"
 
   git config --global user.email "your_email@youremail.com"
Line 13: Line 16:
 
   git config --list
 
   git config --list
  
 +
== Installing git-review ==
 
On Ubuntu, MacOSx, or most other Unix-like systems, it is as simple as:
 
On Ubuntu, MacOSx, or most other Unix-like systems, it is as simple as:
 
   pip install git-review
 
   pip install git-review
  
There are other options detailed in the [[Gerrit_Workflow#Git_Review_Installation|Installation Instructions]]. You can now check out the Solum code and begin working on it:
+
There are other installation options detailed in the [[Gerrit_Workflow#Git_Review_Installation|Installation Instructions]]. You can now check out the Solum code and begin working on it:
  
 +
= Checking out/in code =
 
   git clone git://git.openstack.org/stackforge/solum
 
   git clone git://git.openstack.org/stackforge/solum
 
   cd solum
 
   cd solum

Revision as of 22:48, 31 October 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:

Checking out/in code

 git clone git://git.openstack.org/stackforge/solum
 cd solum

.. add awesome code ..

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

Once you code is submitted for review, "Sign In" at https://review.openstack.org/ to track the review. Upon approval of the review your code will be automatically merged.