| Index: doc/contributing.html
|
| diff --git a/doc/contributing.html b/doc/contributing.html
|
| index a22b3ab93c55a1209976e22fb4810c81892045da..018083f37e787955ce69fcc8e344889c7af9a1af 100644
|
| --- a/doc/contributing.html
|
| +++ b/doc/contributing.html
|
| @@ -16,18 +16,20 @@
|
| <tr><td> </td></tr>
|
|
|
| <tr><td><b>Docs and Info</b></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="findbugs2.html">FindBugs 2.0</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="ja/manual/index.html">Manual(ja/日本語)</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="findbugs2.html">FindBugs 2.0</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="manual/index.html">Manual</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="ja/manual/index.html">Manual(ja/日本語)</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="bugDescriptions_ja.html">Bug descriptions(ja/日本語)</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="bugDescriptions_fr.html">Bug descriptions(fr)</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="links.html">Links</a></font></td></tr>
|
|
|
| <tr><td> </td></tr>
|
|
|
| @@ -40,15 +42,15 @@
|
| <tr><td> </td></tr>
|
|
|
| <tr><td><b>Development</b></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/tracker/?group_id=96405">Open bugs</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
|
| -<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>
|
| -<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/browse/">Browse source</a></font></td></tr>
|
| -<tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/list">Latest code changes</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="http://sourceforge.net/p/findbugs/bugs/">Open bugs</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="team.html">Dev team</a></font></td></tr>
|
| +<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>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="http://code.google.com/p/findbugs/source/browse/">Browse source</a></font></td></tr>
|
| +<tr><td><font size="-1"> <a class="sidebar" href="http://code.google.com/p/findbugs/source/list">Latest code changes</a></font></td></tr>
|
| </table>
|
| </td>
|
|
|
| @@ -61,45 +63,47 @@ we would be happy to consider it for inclusion.</p>
|
|
|
| <h2>Import FindBugs code as Eclipse projects</h2>
|
|
|
| -<p>The preferred way to get the FindBugs source code and create the patch is to use Eclipse + SVN.
|
| +<p>The preferred way to get the FindBugs source code and create the patch is to use Eclipse + Git.
|
| You can easily import FindBugs code into Eclipse by following the steps described
|
| -here: <a href="http://code.google.com/p/findbugs/source/browse/trunk/eclipsePlugin/doc/building_findbugsplugin.txt">Import Eclipse projects</a>
|
| -.
|
| +here: <a href="https://code.google.com/p/findbugs/source/browse/eclipsePlugin/doc/building_findbugsplugin.txt">Import Eclipse projects</a>
|
| +.
|
| </p>
|
|
|
| <h2>Preparing a patch</h2>
|
|
|
| -<p> The best way to
|
| -send an enhancement is to create a patch against the latest code
|
| -in the FindBugs Subversion repository
|
| -at <a href="http://findbugs.googlecode.com/svn/trunk/">http://findbugs.googlecode.com/svn/trunk/</a>
|
| -(those people who have been given commit priviledges should use
|
| -<a href="https://findbugs.googlecode.com/svn/trunk/">http<b>s</b>://findbugs.googlecode.com/svn/trunk/</a>).
|
| -</p>
|
| -
|
| -<p>To create a patch from Eclipse, please right click the [findbugs] or [findBugsEclipsePlugin] project
|
| -and choose [Team | Create Patch...] context menu.
|
| +<p> The best way to create a patch is to clone FindBugs Git repository here:
|
| + <a href="http://code.google.com/p/findbugs/source/clones">http://code.google.com/p/findbugs/source/clones</a>,
|
| + commit changes with descriptive commit messages (small commits are better) and
|
| + create a new <a href="https://sourceforge.net/p/findbugs/bugs/">bug</a>
|
| + or <a href="https://sourceforge.net/p/findbugs/feature-requests/">feature request</a>
|
| + with the "[patch]" prefix in the title and link to your repository in the description.
|
| </p>
|
|
|
| <p> Please follow these guidelines when preparing your patch:</p>
|
| <ul>
|
| <li> <b>Use the same indentation style as the source file(s) you
|
| - are modifying</b>. In particular, please use tabs (not spaces)
|
| - to indent your code; one tab per indent level.
|
| + are modifying</b>. In particular, please use spaces
|
| + to indent your code; four spaces per indent level.
|
| <li> If at all possible, avoid making whitespace modifications.
|
| -<li> Small patches are appreciated.
|
| +<li> Small patches/changesets are appreciated.
|
| +<li> If you have lot of changes, try to group them by small commits with descriptive messages.
|
| +<li> If you have multiple patches, create <b>branch per patch</b>.
|
| +<li> All new files should contain proper license header (<a href="http://www.gnu.org/licenses/lgpl.html">Lesser GNU Public License</a>).
|
| <li> If you are submitting a new bug detector, please submit a small
|
| standalone source file that contains an instance of the
|
| - kind of bug the detector looks for.
|
| + kind of bug the detector looks for. The file should be placed at
|
| + <a href="https://code.google.com/p/findbugs/source/browse/#git%2FfindbugsTestCases%2Fsrc%2Fjava%2FsfBugsNew">findbugsTestCases/src/java/sfBugsNew</a>
|
| + package and named after the bug or feature you are addressing.
|
| </ul>
|
|
|
| <p> Following these guidelines makes it much easier for us
|
| to incorporate new code.
|
|
|
| -<h2>How to submit a patch</h2>
|
| +<h2>Where to submit a patch</h2>
|
|
|
| <p> Patches may be submitted through the
|
| -<a href="http://sourceforge.net/tracker/?atid=614695&group_id=96405&func=browse">Patches</a> tracker on the
|
| +<a href="https://sourceforge.net/p/findbugs/bugs/">bug</a>
|
| + or <a href="https://sourceforge.net/p/findbugs/feature-requests/">feature request</a> trackers on the
|
| <a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>.
|
|
|
|
|
| @@ -111,7 +115,7 @@ document.write( "Last updated "+ document.lastModified + "." );
|
| </script>
|
| <p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
|
| <p>
|
| -<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>
|
| +<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" alt="FindBugs on SourceForge.net" /></a>
|
|
|
| </td>
|
|
|
|
|