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 |
(...skipping 24 matching lines...) Expand all Loading... |
35 | 35 |
36 <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> |
37 | 37 |
38 <tr><td> </td></tr> | 38 <tr><td> </td></tr> |
39 | 39 |
40 <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> |
41 | 41 |
42 <tr><td> </td></tr> | 42 <tr><td> </td></tr> |
43 | 43 |
44 <tr><td><b>Development</b></td></tr> | 44 <tr><td><b>Development</b></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> | 45 <tr><td><font size="-1"> <a class="sidebar" href="http://sourceforge.net/p/
findbugs/bugs/">Open bugs</a></font></td></tr> |
46 <tr><td><font size="-1"> <a class="sidebar" href="reportingBugs.html">Repor
ting bugs</a></font></td></tr> | 46 <tr><td><font size="-1"> <a class="sidebar" href="reportingBugs.html">Repor
ting bugs</a></font></td></tr> |
47 <tr><td><font size="-1"> <a class="sidebar" href="contributing.html">Contri
buting</a></font></td></tr> | 47 <tr><td><font size="-1"> <a class="sidebar" href="contributing.html">Contri
buting</a></font></td></tr> |
48 <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> |
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> | 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> |
50 <tr><td><font size="-1"> <a class="sidebar" href="Changes.html">Change log<
/a></font></td></tr> | 50 <tr><td><font size="-1"> <a class="sidebar" href="Changes.html">Change log<
/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> | 51 <tr><td><font size="-1"> <a class="sidebar" href="http://sourceforge.net/pr
ojects/findbugs">SF project page</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> | 52 <tr><td><font size="-1"> <a class="sidebar" href="http://code.google.com/p/
findbugs/source/browse/">Browse source</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> | 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> |
54 </table> | 54 </table> |
55 </td> | 55 </td> |
(...skipping 11 matching lines...) Expand all Loading... |
67 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 |
68 here: <a href="https://code.google.com/p/findbugs/source/browse/eclipsePlugin/do
c/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> |
69 . | 69 . |
70 </p> | 70 </p> |
71 | 71 |
72 <h2>Preparing a patch</h2> | 72 <h2>Preparing a patch</h2> |
73 | 73 |
74 <p> The best way to create a patch is to clone FindBugs Git repository here: | 74 <p> The best way to create a patch is to clone FindBugs Git repository here: |
75 <a href="http://code.google.com/p/findbugs/source/clones">http://code.google.co
m/p/findbugs/source/clones</a>, | 75 <a href="http://code.google.com/p/findbugs/source/clones">http://code.google.co
m/p/findbugs/source/clones</a>, |
76 commit changes with descriptive commit messages (small commits are better) and | 76 commit changes with descriptive commit messages (small commits are better) and |
77 create a new <a href="https://sourceforge.net/p/findbugs/patches/">patch ticket
</a> | 77 create a new <a href="https://sourceforge.net/p/findbugs/bugs/">bug</a> |
78 with the link to your repository. | 78 or <a href="https://sourceforge.net/p/findbugs/feature-requests/">feature reque
st</a> |
| 79 with the "[patch]" prefix in the title and link to your repository in the descr
iption. |
79 </p> | 80 </p> |
80 | 81 |
81 <p> Please follow these guidelines when preparing your patch:</p> | 82 <p> Please follow these guidelines when preparing your patch:</p> |
82 <ul> | 83 <ul> |
83 <li> <b>Use the same indentation style as the source file(s) you | 84 <li> <b>Use the same indentation style as the source file(s) you |
84 are modifying</b>. In particular, please use spaces | 85 are modifying</b>. In particular, please use spaces |
85 to indent your code; four spaces per indent level. | 86 to indent your code; four spaces per indent level. |
86 <li> If at all possible, avoid making whitespace modifications. | 87 <li> If at all possible, avoid making whitespace modifications. |
87 <li> Small patches/changesets are appreciated. | 88 <li> Small patches/changesets are appreciated. |
| 89 <li> If you have lot of changes, try to group them by small commits with descrip
tive messages. |
| 90 <li> If you have multiple patches, create <b>branch per patch</b>. |
| 91 <li> All new files should contain proper license header (<a href="http://www.gnu
.org/licenses/lgpl.html">Lesser GNU Public License</a>). |
88 <li> If you are submitting a new bug detector, please submit a small | 92 <li> If you are submitting a new bug detector, please submit a small |
89 standalone source file that contains an instance of the | 93 standalone source file that contains an instance of the |
90 kind of bug the detector looks for. | 94 kind of bug the detector looks for. The file should be placed at |
| 95 <a href="https://code.google.com/p/findbugs/source/browse/#git%2FfindbugsTe
stCases%2Fsrc%2Fjava%2FsfBugsNew">findbugsTestCases/src/java/sfBugsNew</a> |
| 96 package and named after the bug or feature you are addressing. |
91 </ul> | 97 </ul> |
92 | 98 |
93 <p> Following these guidelines makes it much easier for us | 99 <p> Following these guidelines makes it much easier for us |
94 to incorporate new code. | 100 to incorporate new code. |
95 | 101 |
96 <h2>How to submit a patch</h2> | 102 <h2>Where to submit a patch</h2> |
97 | 103 |
98 <p> Patches may be submitted through the | 104 <p> Patches may be submitted through the |
99 <a href="https://sourceforge.net/p/findbugs/patches/">Patches</a> tracker on the | 105 <a href="https://sourceforge.net/p/findbugs/bugs/">bug</a> |
| 106 or <a href="https://sourceforge.net/p/findbugs/feature-requests/">feature reque
st</a> trackers on the |
100 <a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>
. | 107 <a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>
. |
101 | 108 |
102 | 109 |
103 <hr> <p> | 110 <hr> <p> |
104 <script language="JavaScript" type="text/javascript"> | 111 <script language="JavaScript" type="text/javascript"> |
105 <!---//hide script from old browsers | 112 <!---//hide script from old browsers |
106 document.write( "Last updated "+ document.lastModified + "." ); | 113 document.write( "Last updated "+ document.lastModified + "." ); |
107 //end hiding contents ---> | 114 //end hiding contents ---> |
108 </script> | 115 </script> |
109 <p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbu
gs@cs.umd.edu</a> | 116 <p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbu
gs@cs.umd.edu</a> |
110 <p> | 117 <p> |
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> | 118 <a href="http://sourceforge.net/projects/findbugs/"><img src="http://sourceforge
.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" al
t="FindBugs on SourceForge.net" /></a> |
112 | 119 |
113 </td> | 120 </td> |
114 | 121 |
115 </tr></table> | 122 </tr></table> |
116 | 123 |
117 </body> | 124 </body> |
118 </html> | 125 </html> |
OLD | NEW |