Author: bimargulies
Date: Sun Sep 14 17:12:03 2014
New Revision: 1624874
URL: http://svn.apache.org/r1624874
Log:
(no JIRA) link to the git doc from the overall guide, add more info to the git
doc.
Modified:
maven/site/trunk/content/apt/developers/conventions/git.apt
maven/site/trunk/content/apt/guides/development/guide-helping.apt
Modified: maven/site/trunk/content/apt/developers/conventions/git.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/conventions/git.apt?rev=1624874&r1=1624873&r2=1624874&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/conventions/git.apt (original)
+++ maven/site/trunk/content/apt/developers/conventions/git.apt Sun Sep 14
17:12:03 2014
@@ -28,17 +28,51 @@
Maven Git Convention
- This document describes how developers should use Git, our SCM.
+ 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.
* Git migration
- ETA of git migration is here:
{{https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration}}
+ Information on the migration is here:
{{https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration}}
* Git Configuration
- TODO
+** For contributors who are not committers
-* {Commit Message Template}
+ Apache git repositories are at
+ <<git://git.apache.org>>>. However, the ASF
+ uses clones on github.com to make it easier for people to contribute
+ changes via pull requests.
+
+ To contribute to a Maven component that is maintained in git, please
+ follow these steps:
+
+ [[1]] 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.
+
+ [[2]] Make a fork of the offical ASF clone from github.com. For
+ example, <<<https://github.com/apache/maven-scm>>>.
+
+ [[3]] Make a branch named after your JIRA. This is not <required>,
+ but it makes it easier for Maven commiters to keep track of your
+ contribution.
+
+ [[4]] Make your changes. As always, unit or integration tests make
+ it much easier for us to accept your changes.
+
+ [[5]] 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.
+
+** For committers
+
+ 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.
+
+*** {Commit Message Template}
Commits should be focused on one issue at a time, because that makes it
easier
for others to review the commit.
@@ -72,10 +106,25 @@ Submitted by: Baz Bazman
o Applied without change
+-----+
-* Apply User Patch
+*** Apply User Patch
- By default, the committer should apply the patch without any <<major>>
modifications. In a second step, the committer
- could apply any changes as usual.
+ To keep the history of contributions clear,
+ The committer should usually apply the patch without any <<major>>
+ 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.
+
+ 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:
+
++----+
+ Closes #NNN.
++----+
+
+ where NNN is the number of the pull request.
* Edit Commit Message
@@ -126,7 +175,7 @@ $ git checkout .
-* power-git checkout
+*** power-git checkout
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
@@ -182,10 +231,3 @@ git checkout pr/10
git rebase apache/master
git push apache
---
-
-
-
-
-
-
-
Modified: maven/site/trunk/content/apt/guides/development/guide-helping.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/content/apt/guides/development/guide-helping.apt?rev=1624874&r1=1624873&r2=1624874&view=diff
==============================================================================
--- maven/site/trunk/content/apt/guides/development/guide-helping.apt (original)
+++ maven/site/trunk/content/apt/guides/development/guide-helping.apt Sun Sep
14 17:12:03 2014
@@ -86,6 +86,8 @@ Developers Conventions
* {{{../../developers/conventions/svn.html}Maven SVN Convention}}
+ * {{{../../developers/conventions/git.html}Maven GIT Convention}}
+
* {{{../../developers/release/index.html}Releasing a maven project}}
[]
