search

surrealdb / surrealdb.java

SurrealDB SDK for Java
https://surrealdb.com
Apache License 2.0
67 stars 21 forks source link

Add Gradle spotless plugin #29

Closed eharrow closed 1 year ago

eharrow commented 1 year ago

This PR adds the Spotless plugin to the Gradle build. Spotless will help to keep the source formatting to a set standard and is pretty common across many projects. I opted for the Google style as it seems pretty standard.

Also added a copy/amended version of the CONTRIBUTING.md.

This PR does not include any of the resulting source code changes from running gradle spotlessJavaApply. N.B. the plugin is called as part of gradle check and will block the build if the source deviates from the standard.

Any way see what you think.

phughk commented 1 year ago

Hey @eharrow, we have checkstyle to verify format. We don't need spotless even though it is a convenience. It seems like additional maintenance for something that IDEs already do.

eharrow commented 1 year ago

Understood re check style but I cannot find a way to have it apply the formatting and instead have to rely on an IDE.

phughk commented 1 year ago

I changed the checkstyle to google. Let's rock n roll.