diff options
Diffstat (limited to 'thirdparty/checkstyle/site/contributing.html')
| -rwxr-xr-x | thirdparty/checkstyle/site/contributing.html | 432 |
1 files changed, 432 insertions, 0 deletions
diff --git a/thirdparty/checkstyle/site/contributing.html b/thirdparty/checkstyle/site/contributing.html new file mode 100755 index 000000000..5d787fa13 --- /dev/null +++ b/thirdparty/checkstyle/site/contributing.html @@ -0,0 +1,432 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>checkstyle - Contributing</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Checkstyle Development Team" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <span id="bannerLeft">
+
+ Checkstyle 5.3
+
+ </span>
+ <a href="" id="bannerRight">
+
+ <img src="images/logo.png" alt="Checkstyle" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2010-10-19
+ </div>
+ <div class="xright">
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>About</h5>
+ <ul>
+
+ <li class="none">
+ <a href="index.html">Checkstyle</a>
+ </li>
+
+ <li class="none">
+ <a href="releasenotes.html">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+ <li class="expanded">
+ <a href="config.html">Configuration</a>
+ <ul>
+
+ <li class="none">
+ <a href="property_types.html">Property Types</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="running.html">Running</a>
+ <ul>
+
+ <li class="none">
+ <a href="anttask.html">Ant Task</a>
+ </li>
+
+ <li class="none">
+ <a href="cmdline.html">Command Line</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="availablechecks.html">Available Checks</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="checks.html">Standard Checks</a>
+ <ul>
+
+ <li class="none">
+ <a href="config_annotation.html">Annotations</a>
+ </li>
+
+ <li class="none">
+ <a href="config_blocks.html">Block Checks</a>
+ </li>
+
+ <li class="none">
+ <a href="config_design.html">Class Design</a>
+ </li>
+
+ <li class="none">
+ <a href="config_coding.html">Coding</a>
+ </li>
+
+ <li class="none">
+ <a href="config_duplicates.html">Duplicate Code</a>
+ </li>
+
+ <li class="none">
+ <a href="config_header.html">Headers</a>
+ </li>
+
+ <li class="none">
+ <a href="config_imports.html">Imports</a>
+ </li>
+
+ <li class="none">
+ <a href="config_javadoc.html">Javadoc Comments</a>
+ </li>
+
+ <li class="none">
+ <a href="config_metrics.html">Metrics</a>
+ </li>
+
+ <li class="none">
+ <a href="config_misc.html">Miscellaneous</a>
+ </li>
+
+ <li class="none">
+ <a href="config_modifier.html">Modifiers</a>
+ </li>
+
+ <li class="none">
+ <a href="config_naming.html">Naming Conventions</a>
+ </li>
+
+ <li class="none">
+ <a href="config_regexp.html">Regexp</a>
+ </li>
+
+ <li class="none">
+ <a href="config_sizes.html">Size Violations</a>
+ </li>
+
+ <li class="none">
+ <a href="config_whitespace.html">Whitespace</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="extending.html">Extending Checkstyle</a>
+ <ul>
+
+ <li class="none">
+ <a href="writingchecks.html">Writing checks</a>
+ </li>
+
+ <li class="none">
+ <a href="writingfilters.html">Writing filters</a>
+ </li>
+
+ <li class="none">
+ <a href="writinglisteners.html">Writing listeners</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <h5>Developers</h5>
+ <ul>
+
+ <li class="none">
+ <a href="apidocs/index.html">Javadoc</a>
+ </li>
+
+ <li class="none">
+ <a href="http://sourceforge.net/projects/checkstyle" class="externalLink">Project Page</a>
+ </li>
+
+ <li class="none">
+ <strong>Contributing</strong>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+
+
+
+ <a href="http://sourceforge.net/projects/checkstyle" title="SourceForge" class="poweredBy">
+ <img alt="SourceForge" src="http://sflogo.sourceforge.net/sflogo.php?group_id=29721&type=11" />
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2><a name="Introduction"></a>Introduction</h2>
+<p> + Hey, good to see you on this page. It means that you are + considering a contribution of your own work to the Checkstyle + project. We welcome anything: bugfixes, new check modules, unit + tests, documentation improvements, build process simplification, + etc. + </p>
+<p> + This document assumes you are working with the SVN version of + checkstyle and that you are familiar with some standard + development tools ( + + <a href="http://subversion.tigris.org/" class="externalLink">SVN</a>, + <a href="http://maven.apache.org" class="externalLink">Maven</a>, + <a href="http://www.junit.org" class="externalLink">JUnit</a>). + </p>
+</div>
+<div class="section"><h2><a name="Quality_matters"></a>Quality matters</h2>
+<p> + The developer team of checkstyle is really a lazy bunch of + people. We try to avoid work as best as we can, but most of all + we try to avoid working on bugs that are reported by end users. + </p>
+<p> + To that end, we use a set of development tools that ensure that + the quality of our code is kept at a fairly high level. Like + most projects today, we use JUnit to test our code. However we + do take this one step further and measure the coverage of our + unit tests using + + <a href="http://cobertura.sourceforge.net/" class="externalLink">Cobertura</a>. + + This means it is not sufficient to pass all tests, but the tests + should ideally execute each line in the code. To generate the + Cobertura report, run the Maven command + + <code>mvn cobertura:cobertura</code>. + </p>
+<p> + Besides using unit testing, we obviously also use checkstyle to + check it's own code. + </p>
+<p> + The Maven command <code>mvn clean package</code> must pass + without any errors. + </p>
+<p> + If you add new end user features, remember to document them. + </p>
+</div>
+<div class="section"><h2><a name="Submitting_your_contribution"></a>Submitting your contribution</h2>
+<p> + Once you have made sure that your changes pass the Maven command + <code>mvn clean package</code>, the code coverage is of high + standard and everthing is documented, then you are ready to + submit your work. + </p>
+<p> + If you have created new files, put them in a tgz file (or zip if + you are on Windows). If you have changed existing files, create + a unified diff using SVN. To do that, open a command line, cd to + the home directory of checkstyle (where build.xml is located) + and execute <code>svn diff > mychanges.patch</code>. + </p>
+<p> + Create a new item in our + + <a href="http://sourceforge.net/tracker/?group_id=29721&atid=397080" class="externalLink">patch tracker</a> + + and add the tgz/zip/patch files you created. Make sure the text + in the tracker explains the purpose of your contribution. When + you create a tracker entry, a notification email about your + contribution will automatically be sent to the developer mailing + list. Be prepared to answer questions and do some polishing + work. + </p>
+<p> + We are not only lazy but at times we are also busy with our day + jobs. This means that you might not always get an immediate + answer. You are not being ignored, and we value your work - we + might just be too busy to review your code, especially if it is + a bit complex. If you don't get a response within two weeks, + feel free to send a reminder email about your tracker item. + </p>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2001-2010
+
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
|