Giter VIP home page Giter VIP logo

pentaho-coding-standards's Introduction

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):

  • Install CheckStyle plugin http://eclipse-cs.sf.net/update/
  • Configure the plugin to use the checkstyle/pentaho_checks.xml; give it the raw github URL here
  • Configure the Eclipse Code Formatter to use the attached ide/eclipse_formatter.xml

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).
    • Select "8.0" in the "Checkstyle version" dropdown
    • Select "Only Java sources (including tests) in the "Scan Scope" dropdown
    • Click "Apply"
    • Select "Use a checkstyle file accessible via HTTP" with the raw github URL here
      • Alternatively, you can select "Use a local Checkstyle file". Clone this repo and use the checkstyle/pentaho_checks.xml.
  • Configure code style
    • Copy theide/intelliJ_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.

pentaho-coding-standards's People

Contributors

pentaho-nbaker avatar tmorgner avatar pavel-sakun avatar pminutillo avatar pentaho-whartman avatar dfieldfl avatar dcleao avatar graimundo avatar hbfernandes avatar lucboudreau avatar eduardolimalopes avatar rfellows avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.