Hi All,

We have received some questions about code style and formatting. Currently
we do not have guidelines for code style and haven't really been thinking
about this yet. To increase our code quality and lower the bar for
contributions, developer guidelines should be created as soon as possible.

A proposal has come in the form of a PR [1] to implement the spotless maven
plugin, this plugin can be used to format code using the Google java style
guide [2] and also add the correct header to a file.

This plugin combined with formatter plugins for Eclipse and Intellij [3]
allows all developers to format code in the same way, avoiding PR merge
hell because the formatting of the files changed.

We can then also include/activate checkstyle and RAT maven plugins in our
PR CI builds to check if the code passes our coding standards.

This mail is to see if there are objections against using Google java style
guide, if there are no objections we will move forward to test if all works
as expected, write up a developer guide and do an initial check/format of
all our code.

Hans

[1] https://github.com/project-hop/hop/pull/290
[2] https://google.github.io/styleguide/javaguide.html
[3] https://github.com/google/google-java-format

Reply via email to