Logistics Pipes

Logistics Pipes

13M Downloads

code standards.

AartBluestoke opened this issue ยท 11 comments

commented

BuildCraft has instituted some code formatting standards, I thought I would link the relevant discussion here as lp doesn't have any formal standards.

BuildCraft/BuildCraft#1662 (comment)

commented

My proposal would be: https://github.com/RS485/LogisticsPipes/tree/mc16_cleanup/style
It contains an eclipse formater settings file and an checkstyle file. The checkstyle file is based on sun's standard but reduced by several options.
The branch itself shows the result. It is formated and all checkstyle issues have been resolved.

commented

@AartBluestoke @ArtForz @GUIpsp
Any comments on the proposed checkstyle and eclipse formatter settings?

commented

I would not put it as "they have it, so we should have it(/think about it) as well".
The question is: Do we need it?

commented

I think it would be a good idea. Currently nearly every class looks different inside LP. Some have headers some don't. A general style would also free most diffs from code cleanups

commented

I'd like no headers with sun's standards

commented

Actually I would like a tool that works with Gradle and Jenkins. Is there something like that?

commented

Everyone can comment on this, if they want to.

commented

Yeah, sounds good. @davboecki ?

commented

The files I added contain a setting for eclipse and a checkstyle file. So the checkstyle part could be done on jenkins as well.

commented

To make this up-to-date: Checkstyle will actually be applied when there is no need to merge another version anymore, e.g. mc17-0.9