Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

convert some docs 

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@329977 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter 2005-11-01 05:23:16 +00:00
parent 1287dc32c7
commit f548edfcb2
5 changed files with 134 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
maven-site/src/site/apt/helping.apt
View File

@ -1,68 +1,43 @@
<?xml version="1.0"?> -----
<!-- How to Help
/* -----
* Copyright 2001-2005 The Apache Software Foundation. Brett Porter
* ------
* Licensed under the Apache License, Version 2.0 (the "License"); 1 November 2005
* 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.
*/
-->
<document> How to Help
<properties> As with any open source project, there are several ways you can help:
<author email="brett@apache.org">Brett Porter</author>
<title>How to Help</title> * Join the {{{mail-lists.html} mailing list}} and answer other user's questions
</properties>
* Report bugs, feature requests and other issues in the {{{issue-tracking.html} issue tracking}} application.
* {{{patches.html} Submit patches}} to reported issues (both those you find, or that others have filed)
Your participation in the community is much appreciated!
Why Would I Want to Help?
There are several reasons that are good things.
* By answering other people's questions, you can learn more for yourself
* By submitting your own fixes, they get incorporated faster
* By reporting issues, you ensure that bugs don't get missed, or forgotten
* You are giving back to a community that has given you software for free
How do I Join the Project?
Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a
high extent will be invited to join the project as a committer.
This is as much based on personality and ability to work with other developers and the community as it is with
proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging
rights and nothing else is frowned upon, as is asking to be made a committer without having contributed
sufficiently to be invited.
<body>
<section name="How to Help">
<p>
As with any open source project, there are several ways you can help:
</p>
<ul>
<li>Join the <a href="../mail-lists.html">mailing list</a> and answer other user's questions</li>
<li>Report bugs, feature requests and other issues in the <a href="../issue-tracking.html">issue tracking</a>
application.</li>
<li><a href="patches.html">Submit patches</a> to reported issues (both those you find, or that others have
filed)</li>
</ul>
<p>
Your participation in the community is much appreciated!
</p>
</section>
<section name="Why Would I Want to Help?">
<p>
There are several reasons these are good things.
</p>
<ul>
<li>By answering other people's questions, you can learn more for yourself</li>
<li>By submitting your own fixes, they get incorporated faster</li>
<li>By reporting issues, you ensure that bugs don't get missed, or forgotten</li>
<li>You are giving back to a community that has given you software for free</li>
</ul>
</section>
<section name="How do I Join the Project?">
<p>
Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a
high extent will be invited to join the project as a committer.
</p>
<p>
This is as much based on personality and ability to work with other developers and the community as it is with
proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging
rights and nothing else is frowned upon, as is asking to be made a committer without having contributed
sufficiently to be invited.
</p>
</section>
</body>
</document>

90
maven-site/src/site/apt/patches.apt
View File

@ -1,61 +1,37 @@
<?xml version="1.0"?> -----
<!-- Submitting Patches
/* -----
* Copyright 2001-2005 The Apache Software Foundation. Brett Porter
* ------
* Licensed under the Apache License, Version 2.0 (the "License"); 1 November 2005
* 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.
*/
-->
<document> How to Submit a Patch
<properties> When you fix a bug in the Maven source code, you will submit a patch to the {{{issue-tracking.html} issue tracking
<author email="brett@apache.org">Brett Porter</author> system}} for developers to apply.
<title>Submitting Patches</title>
</properties> First, if this is a new issue of your own that is being fixed, ensure that the issue is actually in the issue
tracking system. Look for an existing one, and if it is not found, create a new one.
Ensure that you have done a full update from source control recently, and have tested your changes. If it is a
new feature or changes the bevahiour of something, make sure to update the relevant documentation. You may
even like to add a <<<changes.xml>>> item describing your change, the issue, and who you are in the
<<<due-to="Your Name">>> attribute.
You should use the Maven code style for your contributions, and be careful to limit changes only to the
relevant areas of the submission. Some {{{developers/code-style.html} code style descriptors}}.
for different IDEs are also available.
Make sure any new files you've created that you want to add have had <<<svn add>>> run on them first.
Prepare the patch by going to the top level of the checkout (the <<<trunk>>>), and running:
------
svn diff >ISSUE-NUMBER.txt
------
Replace ISSUE-NUMBER in the filename with the actual ticket number in the issue tracking system.
Finally, attach the file to the issue tracking system as an attachment.
<body>
<section name="How to Submit a Patch">
<p>
When you fix a bug in the Maven source code, you will submit a patch to the <a href="../issue-tracking.html">issue tracking system</a> for developers to apply.
</p>
<p>
First, if this is a new issue of your own that is being fixed, ensure that the issue is actually in the issue
tracking system. Look for an existing one, and if it is not found, create a new one.
</p>
<p>
Ensure that you have done a full update from source control recently, and have tested your changes. If it is a
new feature or changes the bevahiour of something, make sure to update the relevant documentation. You may
even like to add a <code>changes.xml</code> item describing your change, the issue, and who you are in the
<code>due-to="Your Name"</code> attribute.
</p>
<p>
You should use the Maven code style for your contributions, and be careful to limit changes only to the
relevant areas of the submission. Some <a href="../developers/code-style.html">code style descriptors</a>
for different IDEs are also available.
</p>
<p>
Make sure any new files you've created that you want to add have had <code>svn add</code> run on them first.
</p>
<p>
Prepare the patch by going to the top level of the checkout (the <code>trunk</code>), and running:
</p>
<source>svn diff >ISSUE-NUMBER.txt</source>
<p>
Replace ISSUE-NUMBER in the filename with the actual ticket number in the issue tracking system.
Finally, attach the file to the issue tracking system as an attachment.
</p>
</section>
</body>
</document>

4
maven-site/src/site/apt/where-is-it.apt
View File

@ -1,12 +1,12 @@
------ ------
Where the $%#@!! is it! Where is it?
------ ------
Jason van Zyl Jason van Zyl
------ ------
12 October 2005 12 October 2005
------ ------
Where the $%#@!! is it! Where is it?
As we have moved toward the release of Maven 2.0 we have built up a vast As we have moved toward the release of Maven 2.0 we have built up a vast
store of knowledge that is sometimes hard to communicate with users because store of knowledge that is sometimes hard to communicate with users because

3
maven-site/src/site/site.xml
View File

@ -27,7 +27,8 @@
<item name="Documentation" href="/guides/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="Plug-in Matrix" href="http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Matrix"/>
<item name="Where the $%#@!! is it!" href="/where-is-it.html"/> <item name="Where is it?" href="/where-is-it.html"/>
<item name="How to Help" href="/helping.html"/>
</menu> </menu>
<menu name="About Maven 2.0"> <menu name="About Maven 2.0">

58
maven-site/src/site/xdoc/developers/code-style.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<author email="brett@apache.org">Brett Porter</author>
<title>Maven Code Style</title>
</properties>
<body>
<section name="Maven Code Style">
<p>
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.
</p>
<subsection name="IntelliJ IDEA 4.5+">
<p>
Download <code><a href="maven-codestyle.xml">maven-codestyle.xml</a></code> and copy it to
<code>~/.IntelliJIDEA/config/codestyles</code> then restart IDEA. On Windows, try
<code>C:\Documents and Settings\<i>username</i>\.IntelliJIDEA\config\codestyles</code>.
</p>
<p>
After this, restart IDEA and open the settings to select the new code style.
</p>
</subsection>
<!-- TODO: include sample -->
<subsection name="Eclipse 3.x">
<p>
Download <code><a href="maven-eclipse-codestyle.xml">maven-eclipse-codestyle.xml</a></code>.
</p>
<p>
After this, select Window -&gt; Preferences, and open up the configuration for Java -&gt; Code
Style -&gt; Code Formatter. Click on the button labeled Import... and select the file you
downloaded. Give the style a name, and click OK.
</p>
</subsection>
</section>
</body>
</document>