Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP


Documentation how to patch checkstyle is missing #27

romani opened this Issue · 1 comment

1 participant


Created: 2012-10-31
Creator: Markus Liebelt
SF ticker: 686

I would like to send a patch to one of the open checkstyle bugs, but could not find any documentation how to do that. Where is the documentation how to setup an IDE (preferred Eclipse) to develop a patch?

I tried the following:

Downloaded the binary and source release and tried to setup an Eclipse project with them. I had numerous problems, especially with the class path and the dynamically generated classes.
I do not understand how a build of checkstyle should then be done to test the code.
When I go to the code section, I find there a reference to git ?.

Please provide at least a recipe how to setup a pure Java development environment by providing the essential steps like:

Ensure that Git, Java JDK 1.5/6/7 is installed.
Checkout the current source code from that URL:
Develop the changes
Provide a pull request by ....

Add "Attention" block that new Checks will not be applied to Checkstyle, and need to be tested in Sanbox project, sandbox project already have instructions for Linux.

Does it make sense to support instructions for Windows and MacOs ? if yes - community are welcome to provide them.

@romani romani closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.