Skip to content

Commit aa9d136

Browse files
committed
Add STYLE_GUIDE.md
1 parent 68c1264 commit aa9d136

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,7 @@ See [CHANGELOG](CHANGELOG.md)
202202
### FAQ
203203

204204
See [FAQ](FAQ.md)
205+
206+
### Style Guide
207+
208+
See [STYLE GUIDE](STYLE_GUIDE.md)

STYLE_GUIDE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Style Guide
2+
3+
This project uses CheckStyle to validate the style of the code.
4+
5+
Its automatically executed within the build process and
6+
will fail the build if it detects violations.
7+
8+
You can import the `checkstyle.xml` into your IDE to ease using
9+
the guide.

0 commit comments

Comments
 (0)