summaryrefslogtreecommitdiffstats
path: root/common/checkstyle/src/main/resources/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'common/checkstyle/src/main/resources/README.adoc')
-rw-r--r--common/checkstyle/src/main/resources/README.adoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/common/checkstyle/src/main/resources/README.adoc b/common/checkstyle/src/main/resources/README.adoc
new file mode 100644
index 0000000..d33f39e
--- /dev/null
+++ b/common/checkstyle/src/main/resources/README.adoc
@@ -0,0 +1,6 @@
+= Honeycomb coding resources
+
+* intellij-java-coding-style.xml Can be imported into Intellij IDEA to ensure Honeycomb coding style during development
+* checkstyle.xml Checkstyle config ensuring above HOneycomb coding style
+* checkstyle-license.xml Checkstyle config ensuring Honeycomb license (in HONEYCOMB_LICENSE.txt) header presence
+* checkstyle-logging.xml Checkstyle config ensuring ODL logging standards \ No newline at end of file