Checkstyle is a tool for checking Java source code for adherence to a Code Standardor set of validation rules (best practices).

Members chat: Contributors chat:

The latest release version can be found atGitHub releasesor at Maven repo.

Each-commit builds of maven artifacts can be found atMaven Snapshot repository.

Documentation is available in HTML format, see https://checkstyle.org/checks.html.

Build instructions and Contribution

Build instructions

Setup IDE for development

Explanation on how to create your own module

Verification of code quality

Sending Pull Request

Report Issue

Continuous integration and Quality reports

Travis (Linux & MacOS build): AppVeyor (Windows build):

Quality reports: https://checkstyle.org/project-reports.html

JavaScript, CSS and Java source file analysis on Codacy:

Feedback/Support

Please send any feedback to https://groups.google.com/forum/?hl=en#!forum/checkstyle

Questions and Answers from community:

Bugs and Feature requests (not the questions): https://github.com/checkstyle/checkstyle/issues

Support/Sponsor checkstyle

If you want to speed up fixing of issue and want to encourage somebody ininternet to resolve any issue:

Licensing

This software is licensed under the terms in the file named "LICENSE" in thisdirectory.

The software uses the ANTLR package (https://www.antlr.org/). Its license termsare in the file named "RIGHTS.antlr" in this directory.

This product includes software developed byThe Apache Software Foundation (https://www.apache.org/).

The software uses the Logging and Beanutils packages from theApache Commons project (https://commons.apache.org/). The license termsof these packages are in the file named "LICENSE.apache20" in thisdirectory.

The software uses the Google Guava Libraries(https://github.com/google/guava/). The license terms ofthese packages are in the file named "LICENSE.apache20" in thisdirectory.

The software uses the Picocli Library(https://github.com/remkop/picocli/). Its license termsare in the file named "LICENSE.apache20" in this directory.