Author: brett
Date: Mon Oct 31 21:51:20 2005
New Revision: 329988
URL: http://svn.apache.org/viewcvs?rev=329988&view=rev
Log:
removing docs I converted, as I found them in the guides.
add standard commit template to developer guide and fix some links
Removed:
maven/components/trunk/maven-site/src/site/apt/helping.apt
maven/components/trunk/maven-site/src/site/apt/patches.apt
maven/components/trunk/maven-site/src/site/xdoc/developers/code-style.xml
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-helping.apt
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-m2-development.apt
maven/components/trunk/maven-site/src/site/site.xml
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-helping.apt
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/development/guide-helping.apt?rev=329988&r1=329987&r2=329988&view=diff
==============================================================================
---
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-helping.apt
(original)
+++
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-helping.apt
Mon Oct 31 21:51:20 2005
@@ -43,12 +43,28 @@
rights and nothing else is frowned upon, as is asking to be made a committer
without having contributed
sufficiently to be invited.
-~~ Resources for committers
-~~<li><a href="http://www.apache.org/dev/";>Developer Resources</a></li>
-~~<li><a href="http://www.apache.org/foundation/";>About the Apache Software
Foundation</a></li>
-~~<li><a href="http://www.apache.org/dev/committers.html";>Committer
FAQ</a></li>
-~~<li><a
href="http://www.apache.org/~vgritsenko/stats/projects/maven.html";>Web
Stats</a></li>
-~~<li><a href="http://wiki.apache.org";>Apache Wiki</a></li>
+Developers Conventions
+
+ There are a number of conventions used in the project, which contributors
and developers alike should follow for
+ consistency's sake.
+
+ * {{{guide-m2-development.html#Maven Code Style} Code Style}}
+
+ * {{{guide-m2-development.html#Commit Message Template} Commit Message
Template}}
+
+Resources for committers
+
+ * {{{http://www.apache.org/dev/} Developer Resources}}
+
+ * {{{http://www.apache.org/foundation/} About the Apache Software
Foundation}}
+
+ * {{{http://www.apache.org/dev/committers.html} Committer FAQ}}
+
+ * {{{http://people.apache.org/~vgritsenko/stats/projects/maven.html} Web
Stats}}
+
+ * {{{http://people.apache.org/~coar/mlists.html#maven.apache.org} Mailing
List Stats}}
+
+ * {{{http://wiki.apache.org} Apache Wiki}}
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-m2-development.apt
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/development/guide-m2-development.apt?rev=329988&r1=329987&r2=329988&view=diff
==============================================================================
---
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-m2-development.apt
(original)
+++
maven/components/trunk/maven-site/src/site/apt/guides/development/guide-m2-development.apt
Mon Oct 31 21:51:20 2005
@@ -50,7 +50,7 @@
When you find a issue you would like to work on add a comment in the issue
log so the core developers and other
people looking for work know that someone is already working on it.
-* {{Creating and submitting a patch}}
+* {Creating and submitting a patch}
When you have either completed an issue or just want some feedback on the
work you have done, create a patch
and attach the patch to the issue in question. We have a couple of guidelines
when creating patches:
@@ -206,7 +206,7 @@
{{{http://www.apache.org/dev/version-control.html#https-svn}Committer
Subversion Access}}
document and you must set your svn client with these properties file :
{{svn-eol-style.txt}}
-* Maven Code Style
+* {Maven Code Style}
The following sections show how to set up the code style for Maven in IDEA
and Eclipse.
It is strongly preferred that patches use this style before they are spplied.
@@ -219,10 +219,26 @@
After this, restart IDEA and open the settings to select the new code style.
-** Eclipse 3.x">
+** Eclipse 3.x
Download
<<<{{{../../maven-eclipse-codestyle.xml}maven-eclipse-codestyle.xml}}>>>.
After this, select Window \> Preferences, and open up the configuration for
Java \> Code
Style \> Code Formatter. Click on the button labeled Import... and select the
file you
- downloaded. Give the style a name, and click OK.
\ No newline at end of file
+ downloaded. Give the style a name, and click OK.
+
+* {Commit Message Template}
+
+ Commits should have a message that follows this template:
+
+-----
+PR: issue1, issue2 (using issue keys from JIRA, not URLs)
+Submitted by: (when it was a patch, put that persons name there)
+<< comment >>
+-----
+
+ <<PR>> can be omitted if there was no relevant JIRA issue, though it is
strongly encouraged to create one for significant
+ changes.
+
+ <<Submitted by>> only needs to be specified when a patch is being applied
for a non-committer.
+
\ No newline at end of file
Modified: maven/components/trunk/maven-site/src/site/site.xml
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/site.xml?rev=329988&r1=329987&r2=329988&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/site.xml (original)
+++ maven/components/trunk/maven-site/src/site/site.xml Mon Oct 31 21:51:20 2005
@@ -25,10 +25,10 @@
<item name="Installation Instructions"
href="/download.html#installation"/>
<item name="Getting Started" href="/guides/getting-started/index.html"/>
<item name="Documentation" href="/guides/index.html"/>
- <item name="Available Plug-ins" href="/plugins/index.html"/>
+ <item name="Available Plug-ins" href="/plugins/index.html"/>
<item name="Plug-in Matrix"
href="http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Matrix"/>
<item name="Where is it?" href="/where-is-it.html"/>
- <item name="How to Help" href="/helping.html"/>
+ <item name="How to Help" href="/guides/development/guide-helping.html"/>
</menu>
<menu name="About Maven 2.0">
