forked from checkstyle/checkstyle.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
License
Unity-Engineering-software-engineering/checkstyle.github.io
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html> <!-- | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/contributing.xml at 2025-06-29 | 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.0.0" /> <title>Contributing – checkstyle</title> <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> <script src="./js/apache-maven-fluido-2.0.1.min.js"></script> <script type="text/javascript" src="./js/checkstyle.js"></script> <script type="text/javascript" src="./js/anchors.js"></script> <script type="text/javascript" src="./js/google-analytics.js"></script> <script type="text/javascript" src="./js/copy-clipboard.js"></script> <link rel="icon" href="./images/favicon.png" type="image/x-icon" /> <link rel="shortcut icon" href="./images/favicon.ico" type="image/ico" /> </head> <body> <div class="container-fluid container-fluid-top"> <header> <div id="banner"> <div class="pull-left"><div id="bannerLeft"><h1><a href="./"><img class="class java.lang.Object" src="images/header-checkstyle-logo.png" alt="Checkstyle" /></a></h1></div></div> <div class="pull-right"><div id="bannerRight"><h1><img class="class java.lang.Object" src="images/header-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: 2025-06-29</li> <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 10.26.1</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="index.html">Checkstyle</a></li> <li><a href="releasenotes.html">Release Notes</a></li> <li><a href="consulting.html">Consulting</a></li> <li><a href="sponsoring.html">Sponsoring</a></li> <li class="nav-header">Documentation</li> <li><a href="config.html"><span class="icon-chevron-down"></span>Configuration</a> <ul class="nav nav-list"> <li><a href="property_types.html">Property Types</a></li> <li><a href="config_system_properties.html">System Properties</a></li> </ul></li> <li><a href="running.html"><span class="icon-chevron-down"></span>Running</a> <ul class="nav nav-list"> <li><a href="anttask.html">Ant Task</a></li> <li><a href="cmdline.html">Command Line</a></li> </ul></li> <li><a href="checks.html"><span class="icon-chevron-down"></span>Checks</a> <ul class="nav nav-list"> <li><a href="checks/annotation/index.html"><span class="icon-chevron-right"></span>Annotations</a></li> <li><a href="checks/blocks/index.html"><span class="icon-chevron-right"></span>Block Checks</a></li> <li><a href="checks/design/index.html"><span class="icon-chevron-right"></span>Class Design</a></li> <li><a href="checks/coding/index.html"><span class="icon-chevron-right"></span>Coding</a></li> <li><a href="checks/header/index.html"><span class="icon-chevron-right"></span>Headers</a></li> <li><a href="checks/imports/index.html"><span class="icon-chevron-right"></span>Imports</a></li> <li><a href="checks/javadoc/index.html"><span class="icon-chevron-right"></span>Javadoc Comments</a></li> <li><a href="checks/metrics/index.html"><span class="icon-chevron-right"></span>Metrics</a></li> <li><a href="checks/misc/index.html"><span class="icon-chevron-right"></span>Miscellaneous</a></li> <li><a href="checks/modifier/index.html"><span class="icon-chevron-right"></span>Modifiers</a></li> <li><a href="checks/naming/index.html"><span class="icon-chevron-right"></span>Naming Conventions</a></li> <li><a href="checks/regexp/index.html"><span class="icon-chevron-right"></span>Regexp</a></li> <li><a href="checks/sizes/index.html"><span class="icon-chevron-right"></span>Size Violations</a></li> <li><a href="checks/whitespace/index.html"><span class="icon-chevron-right"></span>Whitespace</a></li> </ul></li> <li><a href="filters/index.html"><span class="icon-chevron-right"></span>Filters</a></li> <li><a href="filefilters/index.html"><span class="icon-chevron-right"></span>File Filters</a></li> <li><a href="style_configs.html"><span class="icon-chevron-down"></span>Style Configurations</a> <ul class="nav nav-list"> <li><a href="google_style.html">Google's Style</a></li> <li><a href="sun_style.html">Sun's Style</a></li> </ul></li> <li class="nav-header">Developers</li> <li><a href="extending.html"><span class="icon-chevron-down"></span>Extending Checkstyle</a> <ul class="nav nav-list"> <li><a href="writingchecks.html">Writing Checks</a></li> <li><a href="writingjavadocchecks.html">Writing Javadoc Checks</a></li> <li><a href="writingfilters.html">Writing Filters</a></li> <li><a href="writingfilefilters.html">Writing File Filters</a></li> <li><a href="writinglisteners.html">Writing Listeners</a></li> </ul></li> <li class="active"><a>Contributing</a></li> <li><a href="beginning_development.html"><span class="icon-chevron-down"></span>Beginning Development</a> <ul class="nav nav-list"> <li><a href="eclipse.html">Eclipse IDE</a></li> <li><a href="netbeans.html">NetBeans IDE</a></li> <li><a href="idea.html">IntelliJ IDE</a></li> </ul></li> <li><a href="apidocs/index.html">Javadoc</a></li> <li class="nav-header">Project Documentation</li> <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li><a href="project-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="https://github.com/checkstyle/checkstyle" class="builtBy"><img class="builtBy" src="images/github_logo_social_coding_outlined.png" alt="GitHub" /></a> <a href="https://twitter.com/checkstyle_java/" class="builtBy"><img class="builtBy" src="images/twitter_button.png" alt="Twitter" /></a> <a href="https://stackoverflow.com/questions/tagged/checkstyle" class="builtBy"><img class="builtBy" src="images/stackoverflow.jpeg" alt="Stackoverflow" /></a> <a href="https://groups.google.com/forum/#!forum/checkstyle" class="builtBy"><img class="builtBy" src="images/groups.png" alt="GoogleGroups" /></a> <a href="https://www.ej-technologies.com/products/jprofiler/overview.html" class="builtBy"><img class="builtBy" src="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="Content"></a> <h1>Content</h1> <ul> <li><a href="#Content">Content</a></li> <li><a href="#Introduction">Introduction</a></li> <li><a href="#Report_An_Issue">Report An Issue</a></li> <li><a href="#Build">Build</a></li> <li><a href="#Quality_Matters">Quality Matters</a></li> <li><a href="#Submitting_Your_Contribution">Submitting Your Contribution</a></li></ul> </section> <section><a id="Introduction"></a> <h1>Introduction</h1> <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 GIT version of checkstyle and that you are familiar with some standard development tools ( <a href="https://git-scm.com" class="externalLink">GIT</a>, <a href="https://maven.apache.org" class="externalLink">Maven</a>, <a href="https://junit.org/junit5/" class="externalLink">JUnit</a>). </p> <p> To start the development - visit our <a href="beginning_development.html">Beginning Development</a> page. </p> <p> <b>ATTENTION:</b> if you have idea how to improve Checkstyle please create issue on our <a href="https://github.com/checkstyle/checkstyle/issues" class="externalLink">tracking system</a>. As soon as one of admins of our project approved your idea you are good to start implementation and you will be welcome with final code contribution. Please do not expect that we will accept any code that you send to us. Example of ideal <a href="checkstyle/checkstyle#258" class="externalLink"> issue description</a>, and how it is commented on fix <a href="checkstyle/checkstyle#601" class="externalLink"> Pull Request</a>. </p> </section> <section><a id="Report_An_Issue"></a> <h1>Report An Issue</h1> <p> All functional changes in the project must be linked to an approved issue. The Issue number has to be referenced in the git commit message, see format below. </p> <p> To report an issue please follow our practices page - <a href="report_issue.html"> How to report an issue?</a> (<a href="report_issue.html#How_to_report_a_bug.3F"> How to report a bug?</a>) </p> </section> <section><a id="Build"></a> <h1>Build</h1> <p> The project follows a general maven layout and phases for its build. Generated jars will be in folder <code>target</code>. </p> <p> Generate maven standard jar: <code>./mvnw clean install</code> <br /> Generate maven standard jar and skip all validations/verifications: <code>./mvnw -P no-validations clean install</code> <br /> Generate uber jar (checkstyle-all-X.XX.jar) to use our <a href="/cmdline.html">command line</a>: <code>./mvnw -P assembly clean package</code> </p> </section> <section><a id="Quality_Matters"></a> <h1>Quality Matters</h1> <p> We use a set of development tools to ensure that the quality of our code is kept at a 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="https://www.eclemma.org/jacoco/" class="externalLink">JaCoCo</a>. This means it is not sufficient to pass all tests, but the tests should ideally execute each line in the code, code coverage should be 100%. To generate the JaCoCo report, run the Maven command: <br /> <code> ./mvnw clean test jacoco:restore-instrumented-classes jacoco:report@default-report </code> . <br /> Check the results of the report in target/site/jacoco/index.html in the project's root folder. </p> <p> Besides using unit testing, we obviously also use checkstyle to check its own code. </p> <p> The Maven command <code>./mvnw clean verify</code> must pass without any errors. </p> <p> If you add new end user features (Check, Filter, ....), remember to document them in JavaDoc of java classes and xdoc files that are used to generate that site. Please recheck the site and all bundles generated by <code>./mvnw clean site</code> </p> <p> We require regression testing for most functional changes, especially for check modules. See our <a href="https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#checkstyle-tester" class="externalLink"> regression testing tool documentation</a> for details. </p> </section> <section><a id="Submitting_Your_Contribution"></a> <h1>Submitting Your Contribution</h1> <p> Once you have made sure that your changes pass the Maven command <code>./mvnw clean verify</code>, the code coverage is of high standard and everything is documented, then you are ready to submit your work. </p> <p> Please create a <a href="https://help.github.com/articles/using-pull-requests/" class="externalLink">Pull Request</a> for your contribution. In the Pull Request description, add any explanations of the implementation nuances. Please read the Pull Request template for more requirements. <b>ATTENTION:</b> Please verify that the Pull Request contains ONLY your intended changes and is based on the most recent HEAD of our master branch. </p> <p> <b>ATTENTION:</b>The commit message must adhere to a certain format. It should be "Issue #Number: Brief single-line message", where NUMBER is the issue number at GitHub (see <a href="https://github.com/checkstyle/checkstyle/commit/9303fd9d971eb55cdfd62686ba2f5698edb2c83e" class="externalLink"> an example</a>). Small changes of configuration files, documentation fixes, etc. can be contributed by starting the commit message with one of "minor:", "config:", "infra:", "doc:", "dependency:" or "spelling:", followed by a space and a brief single-line message. <br /> "supplemental:" is used for PRs/commits that will support other, more significant changes with format as "supplemental: .... for Issue #XXXX" where "XXXX" refers to the issue that requires this supplemental commit. </p> <p> After submitting a Pull Request, it will be automatically checked by <a href="https://travis-ci.org/checkstyle/checkstyle" class="externalLink">Travis</a> and other continuous integration (CI) services. Therefore, please recheck after some minutes that the CIs didn't find any issues with your changes. If there are issues, please fix them by amending commit (not by separate commit) and provide an updated version of the same Pull Request. </p> <p> At times we are 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> </section> </main> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> <p>© 2001–2025 </p> </div> </div> </footer> </body> </html>
About
License
Contributing
Security policy
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published
Languages
- HTML 99.8%
- Other 0.2%