1<html> 2<head> 3<title>Contributing to FindBugs</title> 4<link rel="stylesheet" type="text/css" href="findbugs.css"> 5 6</head> 7<body> 8 9<table width="100%"><tr> 10 11 12<td bgcolor="#b9b9fe" valign="top" align="left" width="20%"> 13<table width="100%" cellspacing="0" border="0"> 14<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr> 15 16<tr><td> </td></tr> 17 18<tr><td><b>Docs and Info</b></td></tr> 19<tr><td><font size="-1"><a class="sidebar" href="findbugs2.html">FindBugs 2.0</a></font></td></tr> 20<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr> 21<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr> 22<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr> 23<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr> 24<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual</a></font></td></tr> 25<tr><td><font size="-1"><a class="sidebar" href="ja/manual/index.html">Manual(ja/日本語)</a></font></td></tr> 26<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr> 27<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr> 28<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr> 29<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr> 30<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr> 31 32<tr><td> </td></tr> 33 34<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr> 35 36<tr><td> </td></tr> 37 38<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr> 39 40<tr><td> </td></tr> 41 42<tr><td><b>Development</b></td></tr> 43<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/tracker/?group_id=96405">Open bugs</a></font></td></tr> 44<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr> 45<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr> 46<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr> 47<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr> 48<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr> 49<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr> 50<tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/browse/">Browse source</a></font></td></tr> 51<tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/list">Latest code changes</a></font></td></tr> 52</table> 53</td> 54 55<td align="left" valign="top"> 56 57<h1>Contributing to FindBugs</h1> 58 59<p> If you have a bug fix or feature enhancement you would like to contribute, 60we would be happy to consider it for inclusion.</p> 61 62<h2>Import FindBugs code as Eclipse projects</h2> 63 64<p>The preferred way to get the FindBugs source code and create the patch is to use Eclipse + SVN. 65You can easily import FindBugs code into Eclipse by following the steps described 66here: <a href="http://code.google.com/p/findbugs/source/browse/trunk/eclipsePlugin/doc/building_findbugsplugin.txt">Import Eclipse projects</a> 67. 68</p> 69 70<h2>Preparing a patch</h2> 71 72<p> The best way to 73send an enhancement is to create a patch against the latest code 74in the FindBugs Subversion repository 75at <a href="http://findbugs.googlecode.com/svn/trunk/">http://findbugs.googlecode.com/svn/trunk/</a> 76(those people who have been given commit priviledges should use 77<a href="https://findbugs.googlecode.com/svn/trunk/">http<b>s</b>://findbugs.googlecode.com/svn/trunk/</a>). 78</p> 79 80<p>To create a patch from Eclipse, please right click the [findbugs] or [findBugsEclipsePlugin] project 81and choose [Team | Create Patch...] context menu. 82</p> 83 84<p> Please follow these guidelines when preparing your patch:</p> 85<ul> 86<li> <b>Use the same indentation style as the source file(s) you 87 are modifying</b>. In particular, please use tabs (not spaces) 88 to indent your code; one tab per indent level. 89<li> If at all possible, avoid making whitespace modifications. 90<li> Small patches are appreciated. 91<li> If you are submitting a new bug detector, please submit a small 92 standalone source file that contains an instance of the 93 kind of bug the detector looks for. 94</ul> 95 96<p> Following these guidelines makes it much easier for us 97to incorporate new code. 98 99<h2>How to submit a patch</h2> 100 101<p> Patches may be submitted through the 102<a href="http://sourceforge.net/tracker/?atid=614695&group_id=96405&func=browse">Patches</a> tracker on the 103<a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>. 104 105 106<hr> <p> 107<script language="JavaScript" type="text/javascript"> 108<!---//hide script from old browsers 109document.write( "Last updated "+ document.lastModified + "." ); 110//end hiding contents ---> 111</script> 112<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a> 113<p> 114<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A> 115 116</td> 117 118</tr></table> 119 120</body> 121</html> 122
