svn commit: r903779 - in /websites/staging/accumulo/trunk/content: ./ git.html

[bu...@apache.org]

Author: buildbot
Date: Wed Mar 26 16:47:11 2014
New Revision: 903779

Log:
Staging update by buildbot for accumulo

Modified:
    websites/staging/accumulo/trunk/content/   (props changed)
    websites/staging/accumulo/trunk/content/git.html

Propchange: websites/staging/accumulo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Mar 26 16:47:11 2014
@@ -1 +1 @@
-1581847
+1581925

Modified: websites/staging/accumulo/trunk/content/git.html
==============================================================================
--- websites/staging/accumulo/trunk/content/git.html (original)
+++ websites/staging/accumulo/trunk/content/git.html Wed Mar 26 16:47:11 2014
@@ -208,6 +208,28 @@ Jira issue ACCUMULO-12345 that affects 1
    in the commit message:</p>
 <p><code>git commit -av</code></p>
 </li>
+</ol>
+<p>Please include the ticket number at the beginning of the log message, and
+   in the first line, as it's easier to parse quickly. For example:</p>
+<div class="codehilite"><pre>`<span class="n">ACCUMULO</span><span class="o">-</span>2428 <span class="n">throw</span> <span class="n">exception</span> <span class="n">when</span> <span class="n">rename</span> <span class="n">fails</span> <span class="n">after</span> <span class="n">compaction</span>`
+</pre></div>
+
+
+<p>Consider following the git log message format described in
+   <a href="http://zachholman.com/talk/more-git-and-github-secrets/">Zach Holman's talk</a>
+   (specifically slides 78-98, beginning at 15:20 into the video). Essentially,
+   leave a short descriptive message in the first line, skip a line, and write
+   more detailed stuff there, if you need to. For example:</p>
+<div class="codehilite"><pre>`<span class="n">ACCUMULO</span><span class="o">-</span>2194 <span class="n">Add</span> <span class="n">delay</span> <span class="k">for</span> <span class="n">randomwalk</span> <span class="n">Security</span> <span class="n">teardown</span>`
+
+`<span class="n">If</span> <span class="n">two</span> <span class="n">Security</span> <span class="n">randomwalk</span> <span class="n">tests</span> <span class="n">run</span> <span class="n">back</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">back</span><span class="p">,</span> <span class="n">the</span> <span class="n">second</span> <span class="n">test</span> <span class="n">may</span> <span class="n">see</span> <span class="n">that</span> <span class="n">the</span>
+<span class="n">table</span> <span class="n">user</span> <span class="n">still</span> <span class="n">exists</span> <span class="n">even</span> <span class="n">though</span> <span class="n">it</span> <span class="n">was</span> <span class="n">removed</span> <span class="n">when</span> <span class="n">the</span> <span class="n">first</span> <span class="n">test</span> <span class="n">was</span> <span class="n">torn</span> <span class="n">down</span><span class="p">.</span>
+<span class="n">This</span> <span class="n">can</span> <span class="n">happen</span> <span class="k">if</span> <span class="n">the</span> <span class="n">user</span> <span class="n">drop</span> <span class="n">does</span> <span class="n">not</span> <span class="n">propagate</span> <span class="n">through</span> <span class="n">Zookeeper</span> <span class="n">quickly</span> <span class="n">enough</span><span class="p">.</span>
+<span class="n">This</span> <span class="n">commit</span> <span class="n">adds</span> <span class="n">a</span> <span class="n">delay</span> <span class="n">to</span> <span class="n">the</span> <span class="k">end</span> <span class="n">of</span> <span class="n">the</span> <span class="n">Security</span> <span class="n">test</span> <span class="n">to</span> <span class="n">give</span> <span class="n">ZK</span> <span class="n">some</span> <span class="n">time</span><span class="p">.</span>`
+</pre></div>
+
+
+<ol>
 <li>
 <p>Assuming others are developing against the version you also are, as you
    work, or before you create your patch, rebase your branch against the remote