Author: buildbot
Date: Sun Sep 14 17:23:13 2014
New Revision: 922178
Log:
Staging update by buildbot for maven
Modified:
websites/staging/maven/trunk/content/ (props changed)
websites/staging/maven/trunk/content/developers/conventions/git.html
websites/staging/maven/trunk/content/guides/development/guide-helping.html
websites/staging/maven/trunk/content/maven-site-1.0-site.jar
Propchange: websites/staging/maven/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Sep 14 17:23:13 2014
@@ -1 +1 @@
-1624859
+1624877
Modified: websites/staging/maven/trunk/content/developers/conventions/git.html
==============================================================================
--- websites/staging/maven/trunk/content/developers/conventions/git.html
(original)
+++ websites/staging/maven/trunk/content/developers/conventions/git.html Sun
Sep 14 17:23:13 2014
@@ -243,15 +243,28 @@
<div id="contentBox">
<!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you under the
Apache License, Version 2.0 (the --><!-- "License"); you may not use this file
except in compliance --><!-- with the License. You may obtain a copy of the
License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!--
--><!-- Unless required by applicable law or agreed to in writing, --><!--
software distributed under the License is distributed on an --><!-- "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or
implied. See the License for the --><!-- specific language governing
permissions and limitations --><!-- under the License. --><!-- NOTE: For help
with the syntax of this file, see: --><!--
http://maven.apache.org/doxia/references/apt-
format.html --><div class="section">
<h2><a name="Maven_Git_Convention"></a>Maven Git Convention</h2>
-<p>This document describes how developers should use Git, our SCM.</p>
+<p>This document describes how developers should use Git. The Maven project is
in the process of migrating some of its components from svn to git.</p>
<div class="section">
<h3><a name="Git_migration"></a>Git migration</h3>
-<p>ETA of git migration is here: <a class="externalLink"
href="https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration";>https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration</a></p></div>
+<p>Information on the migration is here: <a class="externalLink"
href="https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration";>https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration</a></p></div>
<div class="section">
<h3><a name="Git_Configuration"></a>Git Configuration</h3>
-<p>TODO</p></div>
<div class="section">
-<h3><a name="Commit_Message_Template">Commit Message Template</a></h3>
+<h4><a name="For_contributors_who_are_not_committers"></a>For contributors who
are not committers</h4>
+<p>Apache git repositories are at <i>
<<git://git.apache.org</i>>>. However, the ASF uses clones on
github.com to make it easier for people to contribute changes via pull
requests.</p>
+<p>To contribute to a Maven component that is maintained in git, please follow
these steps:</p>
+<ol style="list-style-type: decimal">
+<li>create a JIRA for bug or improvement that you wish to work on. The Maven
project uses JIRA to organize and track our work, and in particular to keep
track of which changes are included in which releases.</li>
+<li>Make a fork of the offical ASF clone from github.com. For example,
<tt>https://github.com/apache/maven-scm</tt>.</li>
+<li>Make a branch named after your JIRA. This is not <i>required</i>, but it
makes it easier for Maven commiters to keep track of your contribution.</li>
+<li>Make your changes. As always, unit or integration tests make it much
easier for us to accept your changes.</li>
+<li>Make a pull request to pull your changes to the offical clone. Add a link
to your pull request to the JIRA. Committers will take it from here.</li>
+<li></li></ol></div>
+<div class="section">
+<h4><a name="For_committers"></a>For committers</h4>
+<p>Committers may, of course, commit directly to the ASF repositories. For
complex changes, you may find it valuable to make a pull request at github to
make it easier to collaborate with others.</p>
+<div class="section">
+<h5><a name="Commit_Message_Template">Commit Message Template</a></h5>
<p>Commits should be focused on one issue at a time, because that makes it
easier for others to review the commit.</p>
<p>A commit message should use this template:</p>
<div class="source">
@@ -263,7 +276,7 @@ o Comments</pre></div>
<ul>
<li><b>ISSUE-1</b> can be omitted if there was no relevant JIRA issue, though
you are strongly encouraged to create one for significant changes.</li>
<li><b>Submitted by</b> only needs to be specified when a patch is being
applied for a non-committer.</li>
-<li><b>Comments</b> some optional words about the
solution.</li></ul></div></div>
+<li><b>Comments</b> some optional words about the
solution.</li></ul></div></div></div></div>
<div class="section">
<h2><a name="eg:"></a>eg:</h2>
<div class="source">
@@ -273,7 +286,11 @@ Submitted by: Baz Bazman
o Applied without change</pre></div>
<div class="section">
<h3><a name="Apply_User_Patch"></a>Apply User Patch</h3>
-<p>By default, the committer should apply the patch without any <b>major</b>
modifications. In a second step, the committer could apply any changes as
usual.</p></div>
+<p>To keep the history of contributions clear, The committer should usually
apply the patch without any <b>major</b> modifications, and then create his or
her own commits for further modifications. However, committers should never
commit code to a live branch which is not suitable to release. If a
contribution requires significant work to make it useful, commit it to a
branch, fix it up, and merge the branch.</p>
+<p>If the user created a pull request, the committer is responsible for
closing that pull request. You do this by adding a note to a commit message:</p>
+<div class="source">
+<pre> Closes #NNN.</pre></div>
+<p>where NNN is the number of the pull request.</p></div>
<div class="section">
<h3><a name="Edit_Commit_Message"></a>Edit Commit Message</h3></div></div>
<div class="section">
@@ -307,9 +324,9 @@ $ git push</pre></div></div>
<p>If you've done a chunk of work and you would like ditch your changes and
start from scratch use this command to revert to the original checkout:</p>
<div>
<pre>$ git checkout .</pre></div>
-<p>TODO .gitignore</p></div>
+<p>TODO .gitignore</p>
<div class="section">
-<h3><a name="power-git_checkout"></a>power-git checkout</h3>
+<h4><a name="power-git_checkout"></a>power-git checkout</h4>
<p>This checkout is typical for highly experienced git users, and may serve as
inspiration for others; as usual the best way to learn is by doing. Sample
shown for maven-surefire</p>
<p>Go to https://github.com/apache/maven-surefire and fork surefire to your
own github account.</p>
<p>Starting with nothing (no existing clone)</p>
@@ -339,7 +356,7 @@ git push apache # upload to apache</pre>
<pre>
git checkout pr/10
git rebase apache/master
-git push apache</pre></div></div></div>
+git push apache</pre></div></div></div></div>
</div>
</div>
<div class="clear">
Modified:
websites/staging/maven/trunk/content/guides/development/guide-helping.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-helping.html
(original)
+++ websites/staging/maven/trunk/content/guides/development/guide-helping.html
Sun Sep 14 17:23:13 2014
@@ -273,6 +273,7 @@ Jason van Zyl" />
<li><a href="../../developers/conventions/code.html">Maven Code Style And
Convention</a></li>
<li><a href="../../developers/conventions/jira.html">Maven JIRA
Convention</a></li>
<li><a href="../../developers/conventions/svn.html">Maven SVN
Convention</a></li>
+<li><a href="../../developers/conventions/git.html">Maven GIT
Convention</a></li>
<li><a href="../../developers/release/index.html">Releasing a maven
project</a></li></ul></div>
<div class="section">
<h2><a name="Resources_for_committers"></a>Resources for committers</h2>
Modified: websites/staging/maven/trunk/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.
