summaryrefslogtreecommitdiffstats
path: root/common/checkstyle/src/main/resources/README.adoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-06-10 15:31:29 +0200
committerMarek Gradzki <mgradzki@cisco.com>2016-06-13 11:50:11 +0000
commit318b9e56d0b11a5ca4ea8da4879b4693bcf8763e (patch)
tree1ad8e338329a8525d1324cbbeac0a55b1342eb54 /common/checkstyle/src/main/resources/README.adoc
parent61d806977c78defd576a67a4c798856e02de7f9a (diff)
Introduce coding style and checkstyle rules
Change-Id: I1e67065393cdb901b81d5c5f8f3cec42f1b39fc8 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
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 000000000..d33f39efc
--- /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