Skip to content

Repository for IDE specific code-style formatters as well as the master CheckStyle template

Notifications You must be signed in to change notification settings

jmcrfp/pentaho-coding-standards

 
 

Repository files navigation

Introduction to Pentaho Coding Standards

Pentaho enforces coding standards and style through the CheckStyle project ( http://checkstyle.sf.net ).

CheckStyle will soon be integrated into our build system. Until that time, you'll need to configure your IDE using the instructions below to to ensure your contributions conform to the standard.

Installation (Eclipse):

The Eclipse CheckStyle plugin documentation my be helpful: http://eclipse-cs.sourceforge.net

Installation (IntelliJ):

  • Install the CheckStyle-IDEA plugin. (available in the default public repository)
  • Configure the CheckStyle-IDEA (Preferences -> Other Settings -> CheckStyle).
  • Configure code style
    • Copy the codeStyleSettings.xml into your IntelliJ project folder ({{IdeaIntelliJProjectFolder}}/.idea/codeStyleSettings.xml). Overwrite if it's already there.
    • Open IntelliJ, set the Project Settings -> Code Style -> Scheme to "Project"

Additional Information

CheckStyle Tips - Learn how to suppress CheckStyle modules for select areas.

About

Repository for IDE specific code-style formatters as well as the master CheckStyle template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • XSLT 100.0%