Skip to content

03. Coding conventions

Ilkka Seppälä edited this page Mar 30, 2024 · 7 revisions

Formatting

The code should be formatted according to Google Java Style Guide.

The coding conventions are automatically checked with Maven Checkstyle plugin.

After installing the Checkstyle plugin to your IDE, the ruleset is available as "Google Checks". You can also run it from the command line: ./mvnw validate.

License headers

The code files should have a license header in place. This is applied automatically using ./mvnw license:format command.

Commit messages

We squash the incoming pull requests, so it doesn't really matter.