UnderwaterApps / overlap2d-runtime-libgdx

Overlap2D - UI and Level Editor libgdx runtime
http://overlap2d.com
Other
170 stars 96 forks source link

Issue a coding standard format to the project #5

Closed erodozer closed 9 years ago

erodozer commented 9 years ago

Right now in the repository, tons of files are not following a consistent format. There are lines that are not indented using tabs instead of spaces, there are lines where the braces break at different locations than others.

Using the standard eclipse formatter over the entire project could help, but it'd be nice to establish a standard format to use on the project. This could be done by creating all the settings in eclipse and exporting that eclipse format to an xml file. Packaging that formatter with the project will insure everything looks fine.

azakhary commented 9 years ago

We were planning on re-writing the runtime, this time with Ashley and some better new architecture that will actually make sense, and be lighter, so we are kinda resistant on fixing this type of things on this one, but agree that this runtime is currently being used by many and it should be kept clean and as bug-less as possible, so if you guys push fixes, I will happily merge. A well as I will too try to contribute to it in near days.

For the architectural changes I was thinking a nice thread with public discussion can be best, I already spoke with several people, including Mario Zechner on how to make this right, so we have pretty good idea where to move. And I would love to share that, and have a discussion, maybe some docs/diagrams before we start.

Now as for the formatting, and standards. I totally agree, let's fix this. For standards, all there are things like not following a naming conventions for item types. (SimpleImage, CompositeItem, .e.g) So it should be decided upon and fixed.

For the general formatting, we should have a config for both Eclipse and IntelliJ. If you can suggest a default config, we can take a look, decide upon and put it into the project. (or edit and put)