crossley 2003/11/17 22:51:12
Added: site/community committer.html Log: Woops, missed some files in previous commit. Revision Changes Path 1.1 cocoon-site/site/community/committer.html Index: committer.html =================================================================== <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <html> <head> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Tips for committers</title> <link type="text/css" href="../skin/page.css" rel="stylesheet"> </head> <body text="#000000" bgcolor="#FFFFFF"> <!--================= start Navigation Path ==================--> <table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td> </tr> <tr> <td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> </table> <!--================= end Navigation Path ==================--> <!--================= start Banner ==================--> <table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <!--================= start Group Logo ==================--> <td bgcolor="#294563"><a href="http://cocoon.apache.org/";><img border="0" class="logoImage" alt="Apache Cocoon" src="../images/cocoon-project-logo.png"></a></td> <!--================= end Group Logo ==================--> <!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://cocoon.apache.org/";><img border="0" class="logoImage" alt="Apache Cocoon" src="../images/cocoon-logo.gif"></a></td> <!--================= end Project Logo ==================--> <!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563"> <form target="_blank" action="http://www.google.com/search"; method="get"> <table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F"> <tr> <td colspan="3"><img height="10" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"><input value="cocoon.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><input name="Search" value="Search" type="submit"> <br> <font face="Arial, Helvetica, Sans-serif" size="2" color="white"> the Apache Cocoon site </font></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td><img alt="" border="0" height="10" width="9" src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td><img alt="" border="0" height="10" width="9" src="../skin/images/search-right.gif"></td> </tr> </table> </form> </td> <!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td valign="bottom" bgcolor="#294563" colspan="2"> <!--================= start Tabs ==================--> <div class="tab"> <table summary="tab bar" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom"> <table summary="selected tab" style="height: 1.8em" border="0" cellpadding="0" cellspacing="0"> <tr> <td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a class="base-selected" href="../index.html">Home</a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-right.gif"></td> </tr> </table> </td> </tr> </table> </div> <!--================= end Tabs ==================--> </td><td bgcolor="#294563"><img alt="" width="1" height="1" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> </table> <!--================= end Banner ==================--> <!--================= start Menu, NavBar, Content ==================--> <table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td valign="top"> <table summary="menu" border="0" cellspacing="0" cellpadding="0"> <tr> <!--================= start left top NavBar ==================--> <td rowspan="3" valign="top"> <table summary="blue line" border="0" cellpadding="0" cellspacing="0"> <tr> <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif"> </font></td> </tr> <tr> <td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> </table> </td> <!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F"> <!--================= start Menu items ==================--> <div class="menu"> <ul> <li> <font color="#CFDCED">Navigation</font> <ul> <li> <a href="../index.html">Main</a> </li> </ul> </li> <li> <font color="#CFDCED">Community</font> <ul> <li> <a href="members.html">Members</a> </li> <li> <a href="contrib.html">Contributing</a> </li> <li> <span class="sel"><font color="#ffcc00">Committer Tips</font></span> </li> <li> <a href="mail-lists.html">Mail Lists</a> </li> <li> <a href="mail-archives.html">Mail Archives</a> </li> </ul> </li> </ul> </div> <!--================= end Menu items ==================--> </td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-right.gif"></td> </tr> <tr> <td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> </table> </td><td valign="top" width="100%"> <table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0"> <!--================= start middle NavBar ==================--> <tr> <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif"> </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif"> </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <tr> <td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <!--================= end middle NavBar ==================--> <!--================= start Content==================--> <tr> <td align="left" width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td colspan="2" align="left" width="100%"> <div class="content"> <table class="title" summary=""> <tr> <td valign="middle"> <h1>Tips for committers</h1> </td> </tr> </table> <ul class="minitoc"> <li> <a href="#overview">Overview</a> </li> <li> <a href="#style">Coding Style Guidelines</a> </li> <li> <a href="#whitespace">Consistent whitespace</a> </li> <li> <a href="#dos2unix">dos2unix and other control-characters</a> </li> </ul> <a name="N1000C"></a><a name="overview"></a> <h3>Overview</h3> <div style="margin-left: 0 ; border: 2px"> <p> These are some tips to help committers to keep our CVS clean. See also <a href="http://www.apache.org/dev/committers.html";>Committers FAQ</a>. </p> </div> <a name="N1001A"></a><a name="style"></a> <h3>Coding Style Guidelines</h3> <div style="margin-left: 0 ; border: 2px"> <p> We do not want to get too concerned about style, other than a few obvious things such as whitespace. Basically just follow the style that is already used by the files that you are working on. We loosely follow the Sun Java Style Guide. </p> </div> <a name="N10024"></a><a name="whitespace"></a> <h3>Consistent whitespace</h3> <div style="margin-left: 0 ; border: 2px"> <p> Whitespace can cause big problems with CVS. If it is inconsistent, then diffs are very hard to follow - actual changes become lost in the noise of whitespace changes. Some developers use editors that attempt to automatically format the whitespace. The trouble is that if CVS files are inconsistent, some of those editors just make it worse. </p> <p> The solution is that some committers who have a proper editor should occasionally correct the whitespace across all CVS files, applying the following rules. </p> <p>For all text files:</p> <ul> <li>Replace all tabs with spaces.</li> <li>No trailing whitespace.</li> <li>No M$-DOS line endings.</li> <li>Newline at end-of-file.</li> <li>Single whitespace between words.</li> </ul> <p>For all Java source files, as for text files plus:</p> <ul> <li>Use 4-space indentation.</li> </ul> <p>For all XML source files, as for text files plus:</p> <ul> <li>Use 2-space indentation.</li> <li>No whitespace at start-of-file.</li> <li>No whitespace at end-of-file (except of course a newline).</li> </ul> </div> <a name="N1005E"></a><a name="dos2unix"></a> <h3>dos2unix and other control-characters</h3> <div style="margin-left: 0 ; border: 2px"> <p> If you are on a UNIX system, when you receive a patch from a contributor on Windows then do a 'dos2unix'. If you are on a Windows system, then ensure that you have a proper CVS client (it is supposed to convert to UNIX line-endings when you commit). </p> <p> Here is one way to find files that have DOS line-endings: <span class="codefrag">find . -type f | xargs grep -l '^M'</span> (to add the ^M use "Ctrl-v Ctrl-m" at the command-line). </p> <p> Here is one way to find files that have any hidden control characters: <span class="codefrag">find . -type f | xargs grep -l '[[:cntrl:]]'</span> </p> </div> <div class="attribution"></div> </div> </td><td width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td> </tr> <!--================= end Content==================--> </table> </td> </tr> </table> <!--================= end Menu, NavBar, Content ==================--> <!--================= start Footer ==================--> <table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0"> <tr> <td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"><a href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a href="../skin/images/chapter.gif"></a><a href="../skin/images/chapter_open.gif"></a><a href="../skin/images/current.gif"></a><a href="/favicon.ico"></a></td> </tr> <tr> <td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright © 2003 The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!-- document.write(" - "+"Last Published: " + document.lastModified); // --></script></font></td> </tr> <tr> <td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td> </tr> </table> <!--================= end Footer ==================--> </body> </html>
