[IGNITE-1236] Create a checkstyle definition and hook it into the Maven build

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Duplicate
• Component/s: build
• Labels: checkstyle
• Assignee: Raúl Kripalani
• Reporter: Raúl Kripalani
• Created: 11/Aug/15 22:39
• Updated: 20/Sep/19 14:09
• Resolved: 20/Sep/19 14:08

Description

The community has put together a comprehensive set of coding guidelines here: https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines.

We need a checkstyle definition that we can enforce automatically via the Maven Checkstyle plugin.

We can choose to output violations as warnings, or to fail the build if violations exist. At this point I would prefer the former to avoid "stopping the world". With such a large codebase it is likely that checkstyle violations are already present.

This will help contributors adequate their style to the community's standard while they are coding, and will reduce frustration otherwise caused by submitting pull requests that do not satisfy guidelines, and having to rectify them at a later stage.

Issue Links

• duplicates: IGNITE-11277 Use maven plugin as default code style checker for project
• relates to: IGNITE-5705 Integrate Checkstyle into the Build Process