build: Added .editorconfig to project

[Oliver-Loeffler]

Issue

Fixes #485

Adds a very basic .editorconfig to the project and the related Maven plug-in to automatically format files on demand.
README.md has been updated accordingly on how to make use of EditorConfig and where to get the plug-in's for the IDEs.

Progress

• Change must not contain extraneous whitespace
• License header year is updated, if required
• The PR name must follow the pre-defined format
• Verify the contributor has signed Gluon Individual Contributor License Agreement (CLA)

Remark 2024-03-19:

The Maven plugin has been removed as the setup did actually not work as expected. However, the .editorconfig works well in IntelliJ IDEA and Eclipse (when equipped with the plugin).

[abhinayagarwal]

@AlmasB should this be PR be marked as build or feat ?

[AlmasB]

@abhinayagarwal yeah looks like a build PR

[abhinayagarwal]

I added TABs in 2 files: one .java and another pom.xml. Then I ran mvn editorconfig:format, it only fixed the pom.xml file and ignored the java file.

Also, is there a way to make the maven build fail if the check fails?

[Oliver-Loeffler]

Well, the Maven Plugin is not really working as expected. Hence my proposal is to remove it. However, I'll contact the author and will ask for help there.

Nevertheless, we can keep the .editorconfig file as this is directly supported by IntelliJ IDEA and (via plugin) by Eclipse. Having this file and a suitable IDE will nevertheless make life easier as the IDE uses the format settings as defined in there.

For now, I've removed the Maven plugin. If we want to reformat, we could still apply checkstyle. Checkstyle works.

[abhinayagarwal]

Yes, checkstyle is a good option. Let's take it up as a separate issue.