1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Language" content="en-gb">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta http-equiv="Expires" content="-1">
<meta http-equiv="Pragma" content="no-cache">
<title>Proxool 0.9.0RC3</title>
<link href="proxool.css" type="text/css" rel="stylesheet">
</head>
<body>
<div style="max-width: 1200px;">
<table border="0" style="min-height: 100%;" cellpadding="0" cellspacing="0" width="100%">
<tbody>
<tr>
<td valign="bottom" width="150">
</td>
<td colspan="2" height="50">
<div class="bannerFinal">
<table cellpadding="0" cellspacing="0" border="0" width="100%">
<tr>
<td height="50">
<span class="titleCaption" style="font-size: 110%; padding: 4px;">
Contributing to Proxool
</span>
</td>
<td valign="middle" height="50">
<div>
<div style="float: right; margin-right: 8px;">
<img src="images/dots.gif" width="80" height="20" border="0" alt="...">
<a href="http://sourceforge.net/projects/proxool"><img src="images/sflogo.png" width="88" height="31" border="0" alt="SourceForge.net Logo"></a>
</div>
</div>
</td>
</tr>
</table>
</div>
<td width="10"> </td>
</tr>
<tr>
<td valign="top" width="150">
<br/>
<br/>
<table
cellpadding="0"
cellspacing="0"
border="0"
width="100%"
>
<tbody>
<tr>
<td valign="top">
<div class="menuBox" >
<div class="menu-inactive"><a class="menu-inactive" href="index.html">Home</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="news.html">News</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="faq.html">FAQ</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="tips.html">Tips</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="changelog.html">Changes</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="future.html">The Future</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="user.html">User Guide</a></div>
<div class="menu-active"><a class="menu-active" href="dev.html">Developer Guide</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="licence.html">Licence</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="credits.html">Credits</a></div>
<div class="menu-separater">Developer Guide:</div>
<div style="margin-left: 8px">
<div class="menu-inactive"><a class="menu-inactive" href="dev.html">Introduction</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="build.html">Build</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="api-dev/index.html">Full API</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="design.html">Design</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="test.html">Testing</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="report.html">Test Report</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="devList.html">Mailing List</a></div>
<div class="menu-active"><a class="menu-active" href="contribute.html">Contribute</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="dependencies.html">Dependencies</a></div>
</div>
</div>
</td>
<td> </td>
</tr>
<tr>
<td>
<table cellpadding="0" cellspacing="0" border="0" summary="">
<tbody>
<tr><td>
<div class="rightItem">
<div class="rightItemHeader">Version 0.9.0RC3</div>
<div class="rightItemContent">
The latest version of this documentation and software is available on our web site:
<br/><a href="http://proxool.sf.net">proxool.sf.net</a>
</div>
</div>
<div class="rightItem">
<div class="rightItemHeader">Donations</div>
<div class="rightItemContent">
You can donate to Proxool in the usual way:
<br/><a href="http://sourceforge.net/project/project_donations.php?group_id=53958">sourceforge.net</a>
</div>
</div>
</td></tr>
<tr>
<td>
<div class="footer">
last updated: 10-Jan-2007
</div>
</td>
</tr>
</tbody>
</table>
</td>
<td> </td>
</tr>
</tbody>
</table>
</td>
<td valign="top" colspan="2">
<table cellpadding="0" cellspacing="0" border="0" width="100%" summary="">
<tbody>
<tr>
<td class="contents" valign="top">
<h1>How to contribute</h1>
<p>You can contribute to the project in a number of ways:</p>
<li>
Use Proxool and tell us about it.<br>
<div class="resource-link">
<a class="resource-link" href="http://sourceforge.net/forum/forum.php?forum_id=192678"><img border="0" src="images/option-selected.gif" width="10" height="10" alt="">
Proxool in the Wild Forum</a>
</div>
</li>
<li>
Tell us what features you would like.<br>
<div class="resource-link">
<a class="resource-link" href="http://sourceforge.net/tracker/?atid=472198&group_id=53958&func=browse"><img border="0" src="images/option-selected.gif" width="10" height="10" alt="">
Feature Request</a>
</div>
</li>
<li>
Tell us if you find a bug.<br>
<div class="resource-link">
<a class="resource-link" href="http://sourceforge.net/tracker/?group_id=53958&atid=472195"><img border="0" src="images/option-selected.gif" width="10" height="10" alt="">
Bug Tracker</a>
</div>
</li>
<li>
Check out the code from <a href="http://sourceforge.net/cvs/?group_id=53958">cvs</a>,
fix a bug and email <a href="mailto:bill@logicalcobwebs.co.uk">Bill</a> your changes.
</li>
<li>
Write documentation, examples, plug-ins, etc. and send them to
<a href="mailto:bill@logicalcobwebs.co.uk">Bill</a>.
</li>
<h1>Code Style</h1>
<p>We use <a href="http://checkstyle.sourceforge.net">CheckStyle</a> [sourceforge.net] to
enforce code styles, which supports the
<a href="http://java.sun.com/docs/codeconv/">Sun Code Conventions</a> [sun.com].</p>
<p>We do have some exceptions however (for reasons of practicality). When we
invoke checkstyle using ant then we use</p>
<pre>
checkstyle.require.version = true
checkstyle.javadoc.scope = nothing
checkstyle.maxlinelen = 200
checkstyle.tab.width = 4
</pre>
<li>
<i>javadocScope</i>: We don't have @param declarations everywhere, and some
dsocumentation is missing. Mostly this is trivial documentation that isn't
really required. But it is one of our objectives to add all javadoc so that we
can eventually remove this restriction.
</li>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
<head>
<meta http-equiv="Expires" content="-1">
<meta http-equiv="Pragma" content="no-cache">
</head>
</html>
|