Add initial style guide

This commit is contained in:
James William Dumay 2016-02-03 09:54:15 +11:00 committed by James Dumay
parent 7d85f15ff8
commit 89f9448c44
1 changed files with 11 additions and 0 deletions

11
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,11 @@
# Style
All contributers will need to follow the style guide below for their changes to be accepted
## All languages
* For all languages the Intellij autoformatter wins, always.
* If we want to change the code style we need to make sure the Intellij formatter config is changed and checked into the repository.
* Please include updates to the autoformatter as a seperate pull request.
## Java
* We follow the [Naming|https://google.github.io/styleguide/javaguide.html#s5-naming], [Programming Practices](https://google.github.io/styleguide/javaguide.html#s6-programming-practices) and [Javadoc](https://google.github.io/styleguide/javaguide.html#s7-javadoc) styles from the [Google Java Style](https://google.github.io/styleguide/javaguide.html) guide.