svn commit: r1605035 - /incubator/brooklyn/site/community/committers.html

[ri...@apache.org]

Author: richard
Date: Tue Jun 24 09:16:27 2014
New Revision: 1605035

URL: http://svn.apache.org/r1605035
Log:
Committers guide - some fixes, simplification, and additional information

Modified:
    incubator/brooklyn/site/community/committers.html

Modified: incubator/brooklyn/site/community/committers.html
URL: http://svn.apache.org/viewvc/incubator/brooklyn/site/community/committers.html?rev=1605035&r1=1605034&r2=1605035&view=diff
==============================================================================
--- incubator/brooklyn/site/community/committers.html (original)
+++ incubator/brooklyn/site/community/committers.html Tue Jun 24 09:16:27 2014
@@ -84,13 +84,10 @@ of the default, <code>origin</code>; thi
 <pre><code>git remote add github https://github.com/apache/incubator-brooklyn.git
 </code></pre>
 
-<p>Edit the <code>.git/config</code> file and modify the <code>[remote "github"]</code> section like this - this will cause every pull request
-to be made available as a remote branch in your workspace.</p>
+<p>For the GitHub remote, add an additional <code>fetch</code> reference which will cause
+every pull request to be made available as a remote branch in your workspace.</p>
 
-<pre><code>[remote "github"]
-url = https://github.com/apache/incubator-brooklyn.git
-    fetch = +refs/heads/*:refs/remotes/github/*
-    fetch = +refs/pull/*/head:refs/remotes/github/pr/*
+<pre><code>git config --local --add remote.github.fetch '+refs/pull/*/head:refs/remotes/github/pr/*'
 </code></pre>
 
 <p>Finally, run <code>git fetch --all</code> to update from all remote repositories - you will see all the pull requests appear:</p>
@@ -108,7 +105,7 @@ url = https://github.com/apache/incubato
 
 <p>If you want to inspect the PR and/or run tests, check out the branch:</p>
 
-<pre><code>git checkout pull/github/1234
+<pre><code>git checkout github/pr/1234
 </code></pre>
 
 <p>To perform the merge, first update your master branch to the latest:</p>
@@ -119,10 +116,14 @@ git pull --rebase
 
 <p>Then merge and push:</p>
 
-<pre><code>git merge pull/github/1234
+<pre><code>git merge --no-ff -m 'This closes #1234' github/pr/1234
 git push apache master
 </code></pre>
 
+<p>Note that this commit message is important, as this is what will trigger the
+pull request to be automatically closed, and the <code>--no-ff</code> means that a merge
+commit will always be created.</p>
+
 <h2 id="alternative-options">Alternative options</h2>
 
 <h3 id="adding-the-remote-reference-to-the-contributors-repository">Adding the remote reference to the contributor’s repository</h3>
@@ -148,6 +149,17 @@ keep the authorship of the commit, so we
 <pre><code>git am pull-request-9876.patch
 </code></pre>
 
+<h2 id="additional-information">Additional information</h2>
+
+<p>Particularly for new committers, you may find the following information useful:</p>
+
+<ul>
+  <li><a href="https://www.apache.org/dev/new-committers-guide.html">Guide for new project
+committers</a></li>
+  <li><a href="https://www.apache.org/dev/committers.html">Committers FAQ</a></li>
+  <li><a href="https://git-wip-us.apache.org/">Git at Apache</a></li>
+</ul>
+
 </div>
 
 <div id="footer">