Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html> <!-- | Generated by Apache Maven Doxia Site Renderer 2.1.0 from src/site/xdoc/contributing.xml at 2026-08-30 | Rendered using Apache Maven Fluido Skin 2.0.1 --> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.1.0" /> <title>Contributing – checkstyle</title> <link rel="stylesheet" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fcss%2Fapache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fcss%2Fsite.css" /> <link rel="stylesheet" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fcss%2Fprint.css" media="print" /> <script src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fapache-maven-fluido-2.0.1.min.js"></script> <script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fcheckstyle.js" defer async></script> <script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fanchors.js" defer async></script> <script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fgoogle-analytics.js" defer async></script> <script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fcopy-clipboard.js" defer async></script> <link rel="icon" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Ffavicon.png" type="image/x-icon" /> <link rel="shortcut icon" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Ffavicon.ico" type="image/ico" /> <script src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fjs%2Fsearch.js" defer async></script> </head> <body> <div class="container-fluid container-fluid-top"> <header> <div id="banner"> <div class="pull-left"><div id="bannerLeft"><h1><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F"><img class="class java.lang.Object" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Fheader-checkstyle-logo.png" alt="Checkstyle" /></a></h1></div></div> <div class="pull-right"><div id="bannerRight"><h1><img class="class java.lang.Object" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Fheader-right-ruler.png" /></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-08-30</li> <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 14.1.0</li> <li class="pull-right"><a>toTop</a></li> </ul> </div> </header> <div class="row-fluid"> <header id="leftColumn" class="span4"> <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About</li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Findex.html">Checkstyle</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Frelease-notes.html">Release Notes</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fconsulting.html">Consulting</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fsponsoring.html">Sponsoring</a></li> <li class="nav-header">Documentation</li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fgetting-started.html">Getting Started</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fconfig.html"><span class="icon-chevron-down"></span>Configuration</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fproperty-types.html">Property Types</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fconfig-system-properties.html">System Properties</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fxpath.html">XPath</a></li> </ul></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Frunning.html"><span class="icon-chevron-down"></span>Running</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fant-task.html">Ant Task</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fcmdline.html">Command Line</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fresult-reports.html">Result Reports</a></li> </ul></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks.html"><span class="icon-chevron-down"></span>Checks</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fannotation%2Findex.html"><span class="icon-chevron-right"></span>Annotations</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fblocks%2Findex.html"><span class="icon-chevron-right"></span>Block Checks</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fdesign%2Findex.html"><span class="icon-chevron-right"></span>Class Design</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fcoding%2Findex.html"><span class="icon-chevron-right"></span>Coding</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fheader%2Findex.html"><span class="icon-chevron-right"></span>Headers</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fimports%2Findex.html"><span class="icon-chevron-right"></span>Imports</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fjavadoc%2Findex.html"><span class="icon-chevron-right"></span>Javadoc Comments</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fmetrics%2Findex.html"><span class="icon-chevron-right"></span>Metrics</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fmisc%2Findex.html"><span class="icon-chevron-right"></span>Miscellaneous</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fmodifier%2Findex.html"><span class="icon-chevron-right"></span>Modifiers</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fmodules%2Findex.html"><span class="icon-chevron-right"></span>Modules</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fnaming%2Findex.html"><span class="icon-chevron-right"></span>Naming Conventions</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fregexp%2Findex.html"><span class="icon-chevron-right"></span>Regexp</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fsizes%2Findex.html"><span class="icon-chevron-right"></span>Size Violations</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fchecks%2Fwhitespace%2Findex.html"><span class="icon-chevron-right"></span>Whitespace</a></li> </ul></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Ffilters%2Findex.html"><span class="icon-chevron-right"></span>Filters</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Ffilefilters%2Findex.html"><span class="icon-chevron-right"></span>File Filters</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fstyle-configs.html"><span class="icon-chevron-down"></span>Style Configurations</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fgoogle-style.html">Google's Style</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fopenjdk-style.html">OpenJDK's Style</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fsun-style.html">Sun's Style</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fdoc-comments-style.html">Documentation Comments Style</a></li> </ul></li> <li class="nav-header">Developers</li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fextending.html"><span class="icon-chevron-down"></span>Extending Checkstyle</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fwriting-checks.html">Writing Checks</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fwriting-javadoc-checks.html">Writing Javadoc Checks</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fwriting-filters.html">Writing Filters</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fwriting-filefilters.html">Writing File Filters</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fwriting-listeners.html">Writing Listeners</a></li> </ul></li> <li class="active"><a>Contributing</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fbeginning-development.html"><span class="icon-chevron-down"></span>Beginning Development</a> <ul class="nav nav-list"> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Feclipse.html">Eclipse IDE</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fnetbeans.html">NetBeans IDE</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fidea.html">IntelliJ IDE</a></li> </ul></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fapidocs%2Findex.html">Javadoc</a></li> <li class="nav-header">Project Documentation</li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fproject-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fproject-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://github.com/checkstyle/checkstyle">https://github.com/checkstyle/checkstyle" class="builtBy"><img class="builtBy" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Fgithub_logo_social_coding_outlined.png" alt="GitHub" /></a> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://twitter.com/checkstyle_java/" rel="nofollow">https://twitter.com/checkstyle_java/" class="builtBy"><img class="builtBy" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Ftwitter_button.png" alt="Twitter" /></a> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://stackoverflow.com/questions/tagged/checkstyle" rel="nofollow">https://stackoverflow.com/questions/tagged/checkstyle" class="builtBy"><img class="builtBy" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Fstackoverflow.jpeg" alt="Stackoverflow" /></a> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://groups.google.com/forum/#!forum/checkstyle" rel="nofollow">https://groups.google.com/forum/#!forum/checkstyle" class="builtBy"><img class="builtBy" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2Fimages%2Fgroups.png" alt="GoogleGroups" /></a> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://www.ej-technologies.com/products/jprofiler/overview.html" rel="nofollow">https://www.ej-technologies.com/products/jprofiler/overview.html" class="builtBy"><img class="builtBy" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" rel="nofollow">https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" alt="JProfiler" /></a> </div> </div> </header> <main id="bodyColumn" class="span8"> <section><a id="Contributing"></a> <h1>Contributing</h1> <p> The contributing guidelines have moved to GitHub. </p> <p> Please see <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcheckstyle%2F%3Ca+href%3D"https://github.com/checkstyle/checkstyle/blob/master/.github/CONTRIBUTING.md">https://github.com/checkstyle/checkstyle/blob/master/.github/CONTRIBUTING.md" class="externalLink"> CONTRIBUTING.md </a> for the complete and up-to-date documentation. </p> </section> </main> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> <p>© 2001–2026 </p> </div> </div> </footer> </body> </html>