Jump to: navigation, search

Difference between revisions of "Your first patch (Zaqar)"

m (Set up your contributor account)
m (Get the code)
Line 17: Line 17:
 
</nowiki></pre>
 
</nowiki></pre>
  
Check out how to set up a Marconi's basic deployment in [https://github.com/openstack/marconi Marconi's repositorie in Github].
+
Check out how to set up a Marconi's basic deployment in [https://github.com/openstack/marconi Marconi's repository in Github].
  
 
=== Hack, hack, hack! ===
 
=== Hack, hack, hack! ===

Revision as of 04:57, 11 May 2014

Learn how we work

Set up your contributor account

Get the code

git clone https://github.com/openstack/marconi.git

Check out how to set up a Marconi's basic deployment in Marconi's repository in Github.

Hack, hack, hack!

Pick a bug

You can start tacking some bugs from the bugs list in Launchpad. When you find a bug you want to work on, just assign yourself. Make sure to read the bug report and, if you need more information, ask the reporter to provide more details.

If you find a bug that it's not in the bugs list in Launchpad (props for that!), just report it and wait for another developer to confirm it. When it's confirmed, you can start working on it.

To start working on your bug, make sure to follow the Gerrit Workflow.

Design principles

Marconi lives by the following design principles:

  1. DRY
  2. YAGNI
  3. KISS


Try to stick to them when working on your patch, the reviewers will appreciate that!

Submit your patch

Once you finished coding your fix, go ahead and submit it for review. Other Marconi devs will try it and make their comments, and when you get two or more +1 and a core reviewer approves it, it will get merged. Well done!

Common Problems

1. You realized that you were working in master and you HAVEN'T made any commits.

Solution

git checkout -b newbranch     #if you already created the branch, omit the -b
git commit -a -m "Edited"

Now all your changes are in newbranch. Problem solved!

2. You realized that you were working in master and you HAVE made commits to master

Solution

git branch newbranch
git reset --hard HEAD~x    #x is the number of commits you have made to master. YOU WILL LOSE ANY UNCOMMITTED WORK
git checkout newbranch

Your commits are now in newbranch. Problem solved!

3. You made multiple commits and realized that Gerrit needs one commit per patch You need to squash your previous commits. Make sure you are in your branch and follow this guide. Fill in the commit message as specified on the Gerrit Workflow page