giraph-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Avery Ching (Updated) (JIRA)" <>
Subject [jira] [Updated] (GIRAPH-40) Adding checkstyle enforcement of Giraph code conventions
Date Tue, 14 Feb 2012 08:55:59 GMT


Avery Ching updated GIRAPH-40:

    Attachment: GIRAPH-40.patch

As promised, here is the full patch.  Due to its massive size, I am not posting this to reviewboard.
 Here are the details of what I did:

* Created a checkstyle.xml file that follows our CODE_CONVENTIONS as best as possible.
* Compiles will now fail if checkstyle guidelines are not met.
* While checkstyle isn't comprehensive, it should reduce our reviewer overhead for formatting
issues and common code style violations
* Current source code (not test code) now meets checkstyle checks

It passes both the local and MR unittests and also passes rat installation.

Take a look at a few files.  I don't recommend looking at everything since 

$ git diff HEAD^ | grep -P "^(\+|\-)" | wc -l

Let's get this in soon to help us iterate faster and get rid of this technical debt!
> Adding checkstyle enforcement of Giraph code conventions
> --------------------------------------------------------
>                 Key: GIRAPH-40
>                 URL:
>             Project: Giraph
>          Issue Type: New Feature
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-40.patch, GIRAPH-40.patch
> Now that we have some code conventions (see GIRAPH-21), we should enforce them with a
maven checkstyle plugin.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:!default.jspa
For more information on JIRA, see:


View raw message