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