This is an automated email from the ASF dual-hosted git repository. alexey pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/kudu.git
commit fb53b1b18d1f0950b31a668c05a313e271b6864c Author: Greg Solovyev <[email protected]> AuthorDate: Tue Jun 23 14:22:00 2020 -0700 [docs] Add a section about using Gradle checkstyle Coming from Ant/Maven world, I was not aware of Gradle checkStyle plugin and didn't use it before submitting a patch to Gerrit. Knowing about checkStyle would have saved one Gerrit iteration. To save time for future first time Java committers, I added a section about using Gradle checkstyle task to check Java code style. Pre-rendered on my fork: https://github.com/grishick/kudu/blob/master/docs/contributing.adoc#java-code-style Change-Id: Ica45e5fce418fe40fbdcd354bb0c98dc0a653a65 Reviewed-on: http://gerrit.cloudera.org:8080/16105 Tested-by: Kudu Jenkins Reviewed-by: Alexey Serbin <[email protected]> --- docs/contributing.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/contributing.adoc b/docs/contributing.adoc index 4bb8339..09634ca 100644 --- a/docs/contributing.adoc +++ b/docs/contributing.adoc @@ -432,6 +432,17 @@ if (!isCriticalConditionSatisfied) { } ---- +===== Checking code style with Gradle checkStyle + +Before posting a Java patch to Gerrit for review, make sure to check Java code +style with Gradle `checkstyle` plugin. See +link:https://docs.gradle.org/current/userguide/checkstyle_plugin.html[Gradle Checkstyle Plugin documentation] +for more information. +[source,bash] +---- +./gradlew checkstyle +---- + ===== References * link:https://docs.oracle.com/javase/8/docs/technotes/guides/language/assert.html[Programming With Assertions] * link:https://github.com/google/guava/wiki/PreconditionsExplained[Guava Preconditions Explained]
