cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r856606 - in /websites/staging/cloudstack/trunk/content: ./ develop/non-committer.html develop/non-contributors.html
Date Sat, 30 Mar 2013 14:04:00 GMT
Author: buildbot
Date: Sat Mar 30 14:04:00 2013
New Revision: 856606

Staging update by buildbot for cloudstack

    websites/staging/cloudstack/trunk/content/   (props changed)

Propchange: websites/staging/cloudstack/trunk/content/
--- cms:source-revision (original)
+++ cms:source-revision Sat Mar 30 14:04:00 2013
@@ -1 +1 @@

Added: websites/staging/cloudstack/trunk/content/develop/non-committer.html
--- websites/staging/cloudstack/trunk/content/develop/non-committer.html (added)
+++ websites/staging/cloudstack/trunk/content/develop/non-committer.html Sat Mar 30 14:04:00
@@ -0,0 +1,182 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Contributing to Apache CloudStack as a Non-Committer</title>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <link href="/css/bootstrap.css" rel="stylesheet">
+    <link href="/css/bootstrap-responsive.css" rel="stylesheet">
+    <link href="/css/font-awesome.css" rel="stylesheet">
+        <!-- Twitter Bootstrap and jQuery after this line. -->
+        <script src=""></script>
+        <script src="js/bootstrap.js"</script>
+        <script>
+            $('.dropdown-toggle').dropdown();
+            $('.nav-collapse').collapse();
+        </script>
+  </head>
+  <body>
+    <div class="navbar navbar-inverse navbar-fixed-top">
+      <div class="navbar-inner">
+          <a href="/index.html"><img class="logo" src="/images/logo-sm.png"></a>
+          <div class="navbar-search">
+              <form name="search" id="search" action="" method="get">
+                  <input value="" name="sitesearch" type="hidden"/>

+                  <input class="span2" type="text" name="q" id="query">
+                  <button type="submit" id="submit">Search <i class="icon-search"></i></button>
+              </form>
+          </div>
+      </div>
+    </div>
+    <header class="main" id="overview">
+    <div class="container">
+    </div>
+    </header>
+    <div class="container-fluid">
+        <div class="row-fluid">
+            <div class="span3">
+                <ul class="nav nav-list navbar well">
+                    <li>
+                    <h4>Sitemap
+                        <i class="icon-sitemap"></i>
+                    </h4></li>
+                    <hr>
+                    <li><h5>Apache CloudStack</h5></li>
+                    <li><a href="">
+                        <i class="icon-chevron-right"></i>
+                    Downloads</a></li>
+                    <li><a href="">
+                        <i class="icon-chevron-right"></i>
+                    News</a></li>
+                    <li><a href="">
+                        <i class="icon-chevron-right"></i>
+                        About</a></li>
+                    <li><a href="">
+                        <i class="icon-chevron-right"></i>
+                        Who We Are</a></li>
+                <hr>
+                <li><h5>Community</h5></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Get Involved
+                </a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    CloudStack FAQ
+                </a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Mailing Lists</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Events &amp; Meetups</a></li>
+                <hr>
+                <li><h5>Development</h5></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Development Environment</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Contributing for Non-Committers</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Developer's FAQ</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Coding Conventions</a></li>
+                <hr>
+                <li><h5>Documentation</h5></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    CloudStack Documentation</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Apache CloudStack Wiki</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    API Documentation</a></li>
+                <hr>
+                <li><h5>Apache Software Foundation</h5></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Apache Software Foundation</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    ASF Sponsors</a></li>
+                <li><a href="">
+                    <i class="icon-chevron-right"></i>
+                    Security</a></li>
+                </ul>
+            </div>
+            <div class="span9">
+        <p> <h1 id="contributing-to-apache-cloudstack-as-a-non-committer">Contributing
to Apache CloudStack as a Non-Committer</h1>
+<p>If you're a committer on an Apache project, it means that you can commit directly
to the project's repository. For instance, with Apache CloudStack committers are allowed to
directly push commits into the git repository. </p>
+<p>Non-committers, however, have to submit patches for review. Don't worry, it's not
an onerous process at all. The first time you submit a patch, it will take a minute or two
to create an account on <a href="">Review Board</a>,
but it's a piece of cake from start to finish.</p>
+<h2 id="assumptions">Assumptions</h2>
+<p>For the purpose of this post, we'll assume that you already have a system with <a
href="">Git</a> and have found a bug to fix or have a feature
that you'd like to submit, and you're willing to contribute that code or documentation under
the <a href="">Apache License 2.0</a>.</p>
+<p>Further, if you're fixing a bug we'll assume that you've either filed a bug report
or are submitting a fix for a known bug. If you find a bug and would like to fix it, that's
awesome! Please be sure to file the bug too, though. </p>
+<p>If you want to add a feature, you should bring it up for discussion on the cloudstack-dev
mailing list before implementing it. This ensures that it meshes with the plans that other
contributors have for Apache CloudStack, and that you're not doing redundant work. Other developers
may also have ideas for the feature or suggestions that will help you land the feature without
having to re-do the work.</p>
+<p>In short, communication is a vital part of making a contribution to an Apache project.
+<h2 id="getting-started">Getting Started</h2>
+<p>First, lets make sure that you've added your name and email to your <code>~/.gitconfig</code>:</p>
+<p><code>git config --global "Your Name"</code></p>
+<p><code>git config --global</code></p>
+<p>You'll grab the CloudStack source with git:</p>
+<p><code>$ git clone</code></p>
+<p>If you already have the source, make sure you're working with the most recent version.
Do a <code>git pull</code> if you cloned the source more than a few hours ago.
(Apache CloudStack development can move pretty fast!) </p>
+<p>Now that you have an up-to-date copy of the source, create a branch to do your work
+<p><code>$ git checkout -b mybranch</code></p>
+<p>This does two things: One, it creates the branch <em>mybranch</em> and
two, it changes your working branch to <em>mybranch</em>. Running <code>git
branch</code> will show you which branch you're working on, with an asterisk next to
the active branch, like so:</p>
+[user@localhost cloudstack]$ git branch
+  master
+* mybranch
+<p>Make whatever changes you're going to make, be sure to use <code>git add</code>
to stage the changes, and then you're going to commit the changes to your working branch:</p>
+<p><code>git commit -m "Insert a meaningful summary of changes here."</code></p>
+<p>Finally, you're going to create a patch to upload to <a href="">Review
+<p><code>git format-patch master --stdout &gt; ~/patch-name.patch</code></p>
+<h2 id="using-review-board">Using Review Board</h2>
+<p>Review Board is the approved method of sending patches to the Apache CloudStack
project. That's not to say that a patch sent directly to the mailing list will be ignored,
but the <em>strong preference</em> is that patches be submitted through Review
Board. Don't worry, it's a very easy tool to use. </p>
+<p>If you haven't already, create an account with Review Board. Registering only requires
an email address, first name, and last name. After you're registered, head to <a href="">New
Review Request</a> and select the repository (<strong>cloudstack-git</strong>)
and upload the patch (diff) created with git. </p>
+<p>Click <strong>Create Review Request</strong> and then fill out the information
required. Specifically:</p>
+<li>Groups (choose cloudstack)</li>
+<li>People (only use if you need specific committers to review changes)</li>
+<li>Testing Done</li>
+<p>The <strong>Summary</strong> will be the subject that's sent to the
cloudstack-dev mailing list. So if your summary is "fixed feature foo" the subject of the
mail sent to the list will be "Review Request: fixed feature foo". Try to be descriptive with
the Summary. If you're submitting a patch for a bug, please be sure to include the bug number
in the summary. (Like "Bugfix CS-15942: Fixing problem with redundant routers.")</p>
+<p>The description should be a full description of what you've done. Please be specific,
and include enough information that any reviewer will be able to look at your patch without
asking for follow-up information.   You need to include the bug ID that your patch relates
to as well (ex:  CLOUDSTACK-XXX ).</p>
+<p>If you're submitting a patch that modifies code, adds features, etc. you should
test before submitting. Please be sure to describe your tests here. </p>
+<p>Once you're sure everything is OK, go ahead and submit the patch. But that's <em>not</em>
the end of the process. The work isn't done until the patch is committed!</p>
+<h2 id="review">Review</h2>
+<p>Once you've submitted your patch, you should receive a response within a few days.
If you receive no response within a week, please ping the cloudstack-dev mailing list. One
of the features of Review Board is that shows all of the requests and when they were posted,
and the committers know that they should be responsible for reviewing patches in a timely
+<p>When your patch is reviewed, it may be accepted as-is or you may be asked to make
changes. If you're asked to make changes, please work with the committer to see the patch
through to acceptance. </p>
+<p>If the patch is accepted and committed, you have one last task (don't worry, it's
minor and kind of satisfying). </p>
+<p>Go back to Review Board, click <strong>My Dashboard</strong> and then
<strong>Outgoing Reviews</strong>. Go to your submission, you should see a "Ship
it!" message from the reviewer. Click the <strong>Close</strong> button and choose
<strong>Submitted</strong>. The status has now changed from <em>pending</em>
to <em>submitted</em>. </p>
+<p>That's it &ndash; you've helped make Apache CloudStack a better project. Thanks!</p>
+<h2 id="further-reading">Further Reading</h2>
+<p>You might want to peruse the <a href="">Get
Involved</a> page on, and the <a href="">On
Contributing Patches</a> doc as well. Note that some of that does not apply to Apache
CloudStack, as we're using git rather than Subversion. But do respect the original style of
the CloudStack code, and ensure that you're using spaces rather than tabs, and your patches
have Unix line endings (LF) rather than Windows-type line endings (CRLF).</p> </p>
+            </div>
+        </div>
+      <hr>
+      <footer>
+      <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache
License, Version 2.0. Apache and the Apache feather logos are trademarks of The Apache Software
+      </footer>
+    </div>
+  </body>

View raw message