OSGP / Documentation

This repository contains documentation for the Open Smart Grid Platform project. This repository is built as a GitBook, therefore all content has to be written using markdown syntax. See the latest GitBook:
https://documentation.gxf.lfenergy.org/
Apache License 2.0
24 stars 15 forks source link

Updates IDE set up for formatting conventions #249

Closed bvdzwet closed 3 years ago

bvdzwet commented 3 years ago

The documentation described how to configure the Eclipse IDE to format the code in an acceptable way for the XGF code base.

With more developers choosing to use IntelliJ instead of Eclipse, formatting became an issue with pull requests. To have guidelines that are more easily supported across different IDEs the Java formatting conventions are changed to be based on Google Java Format with some additions to honor earier established conventions that can be easily enforced in both Eclipse and IntelliJ.

The documentation now points to the Config repository where more detailed instructions on how to configure the IDEs are available.

jenkins-ip-10-4-24-184 commented 3 years ago

All is well.