mirror of https://github.com/apache/maven.git
removing docs I converted, as I found them in the guides.
add standard commit template to developer guide and fix some links git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@329988 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter
parent
f548edfcb2
commit
9458264fb9
|
|
@ -43,12 +43,28 @@ How do I Join the Project?
|
|||
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}}
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Developing Maven 2
|
|||
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 @@ Available formats
|
|||
{{{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 @@ Available formats
|
|||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
-----
|
||||
How to Help
|
||||
-----
|
||||
Brett Porter
|
||||
------
|
||||
1 November 2005
|
||||
-----
|
||||
|
||||
How to Help
|
||||
|
||||
As with any open source project, there are several ways you can help:
|
||||
|
||||
* Join the {{{mail-lists.html} mailing list}} and answer other user's questions
|
||||
|
||||
* 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.
|
||||
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
-----
|
||||
Submitting Patches
|
||||
-----
|
||||
Brett Porter
|
||||
------
|
||||
1 November 2005
|
||||
-----
|
||||
|
||||
How to Submit a Patch
|
||||
|
||||
When you fix a bug in the Maven source code, you will submit a patch to the {{{issue-tracking.html} issue tracking
|
||||
system}} for developers to apply.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
|
@ -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">
|
||||
|
|
|
|||
|
|
@ -1,58 +0,0 @@
|
|||
<?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 -> 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.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue