You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by da...@apache.org on 2002/07/29 18:22:23 UTC
cvs commit: jakarta-james/www contribute.html
danny 2002/07/29 09:22:23
Added: www contribute.html
Log:
dded contributors how to
Revision Changes Path
1.1 jakarta-james/www/contribute.html
Index: contribute.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="author" value="Danny Angus">
<meta name="email" value="danny@thought.co.uk">
<title>Jakarta James - Contributors How To</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td align="left">
<a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif" border="0"/></a>
</td>
<td align="right">
<a href="http://jakarta.apache.org/james/"><img src="./images/james-logo.jpg" alt="JAMES - Java Apache Mail Enterprise Server" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top" nowrap="true">
<p><strong>James</strong></p>
<ul>
<li> <a href="./index.html">Overview</a>
</li>
<li> <a href="./install.html">Install</a>
</li>
<li> <a href="./configuration_v2_0.html">Configuration</a>
</li>
<li> <a href="./architecture_v2_0.html">Architecture</a>
</li>
<li> <a href="./FAQ.html">James FAQ</a>
</li>
</ul>
<p><strong>Download</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/site/binindex.html">Binaries</a>
</li>
<li> <a href="http://jakarta.apache.org/site/sourceindex.html">Source Code</a>
</li>
</ul>
<p><strong>Guides</strong></p>
<ul>
<li> <a href="./javadocs/index.html">James API</a>
</li>
<li> <a href="./mailet/index.html">Mailet API</a>
</li>
<li> <a href="./usingJDBC_v2.0.html">Using JDBC</a>
</li>
<li> <a href="./usingLDAP_v1_2.html">Using LDAP</a>
</li>
<li> <a href="./usingTLS_v1_2.html">Using TLS</a>
</li>
<li> <a href="http://jakarta.apache.org/james/rfclist">Useful RFCs {web}</a>
</li>
</ul>
<p><strong>Translations {web}</strong></p>
<ul>
<li> <a href="http://www.terra-intl.com/jakarta/james/">Japanese</a>
</li>
</ul>
<p><strong>Project</strong></p>
<ul>
<li> <a href="./code-standards.html">Coding Standards</a>
</li>
<li> <a href="./license.html">License</a>
</li>
<li> <a href="./todo.html">TODO</a>
</li>
<li> <a href="./changelog.html">Changelog</a>
</li>
<li> <a href="http://jakarta.apache.org/site/bugs.html">Bug Database {web}</a>
</li>
<li> <a href="./contribute.html">Contributors How To</a>
</li>
<li> <a href="./weare.html">Who We Are</a>
</li>
</ul>
<p><strong>Jakarta Information {web}</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/site/getinvolved.html">Get Involved</a>
</li>
<li> <a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repositories</a>
</li>
<li> <a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
</li>
<li> <a href="http://jakarta.apache.org/site/library.html">Reference Library</a>
</li>
</ul>
<p><strong>Jakarta Essentials {web}</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/index.html">Front Page</a>
</li>
<li> <a href="http://jakarta.apache.org/site/news.html">News & Status</a>
</li>
<li> <a href="http://jakarta.apache.org/site/mission.html">Mission</a>
</li>
<li> <a href="http://jakarta.apache.org/site/guidelines.html">Guidelines Notes</a>
</li>
<li> <a href="http://jakarta.apache.org/site/faqs.html">FAQs</a>
</li>
</ul>
<p><strong>Related Projects {web}</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/ant/index.html">Ant</a>
</li>
<li> <a href="http://jakarta.apache.org/avalon/index.html">Avalon</a>
</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Introduction"><strong>Introduction</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
<b>anyone can contribute></b><br />
Thats right, we always want to hear from people with contributions to the code,
the documentation, the website and bug reports.<br />
The rest of this document outlines the way to go about these to maximum effect.<br />
</p>
<p>
If you are new to this you may be interested in some of these resources.<br />
<a href="http://jakarta.apache.org/site/guides.html">A good, full, summary of links to guidelines</a><br />
Subscribe to the relevant mailing lists (link on the left).<br />
<a href="http://jakarta.apache.org/site/contributing.html">Craig R. McClanahan's advice how to get involved</a><br />
<a href="http://jakarta.apache.org/site/guidelines.html">How Jakarta projects run</a><br />
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Code Patches"><strong>Code Patches</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
Patches should be submitted to the developers mailing list.<br />
<b>Always</b> use diff -u to generate patches, and make sure it conforms
to the code standards, otherwise it may be ignored.<br />
Prefix the mail subject with [PATCH]<br />
Briefly outline the reason for your patch,
the solution your patch implements, why a patch is
needed and why your code will solve the problem. Note any bug numbers your patch addresses.
</p>
<p>
The reason for these is so that the commiters can easily see what you are trying to achieve,
it is their resonsibility to manage the code and review submissions,
if you make it easy for them to see what you are doing your patch is more likely to
be commited quickly (or at all).<br />
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="New code"><strong>New code</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
Like the principles for patch submission, mark your mail [PATCH] and ensure
your submission conforms to the code standards. Provide a Brief outline of
your intentions, as above, so that your code can be reviewed easily, and a
note of any relevant bug numbers.<br />
New files must contain a refrence to the Apache licence, copy the header from an existing file.<br />
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Bug reporting and fixing"><strong>Bug reporting and fixing</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
Many improvements come as a direct result of bug
reports, and contributed fixes, often by the same person. It is sometimes said that Apache
projects evolve because users become so fed-up waiting for bugs to be addressed that they
fix them themselves. :)<br />
If you report a bug, we'd often appreciate you sending a mail to the users or developers
mailing lists, so that we can discuss it with you, bugzilla isn't a great way for mediating
communication.<br />
If you want to fix a bug, please contribute your changes according to the guidelines above,
in the Code Patches section. It is much simpler to deal with submissions if they all come
through the same channel.
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Documentation"><strong>Documentation</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
While we are glad to accept contributions to documentation
from anyone, in almost any format, because its much better than none, please consider these
guidelines to help us to assimilate your contribution.<br />
To edit an existing document try to edit the xml version in src/xdocs (check it out from cvs)
and if you can, submit a patch as for Code Patches.<br />
If you want to contribute new files please try to use the simple xml format we use.<br />
If this means nothing to you please try to contribute HTML or plain text documents without
any styling, so that we can get at the words and easily convert them into our xml format.<br />
If all this seems like unnecessary nonsense, send us whatever you like, we'd still be
happy to recieve good documentation.
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2002, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>