Skip to content

Commit 696cea7

Browse files
author
Soroosh Sarabadani
committed
add code style to the CONTRIBUTING.md
1 parent e0ccbcb commit 696cea7

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,22 @@ All PRs have to be reviewed and signed off by another developer before being mer
4848
branch. This review will likely ask for some changes to the code - please don't be alarmed or upset
4949
at this; it is expected that all PRs will need tweaks and a normal part of the process.
5050

51+
The PRs are checked to be compliant with the Java Google code style.
52+
5153
Be aware that all Operator SDK code is released under the [Apache 2.0 licence](LICENSE).
5254

53-
### Thanks
55+
## Development environment setup
56+
57+
### Code style
58+
59+
The SDK modules and samples codes following the Java Google code style.
60+
On every `compile` the code gets formatted automatically,
61+
however to have less hassle you can import one of the following code style schemes based on the IDE you use:
62+
63+
- for *Intellij IDEA* import [contributing/intellij-google-style.xml](contributing/intellij-google-style.xml)
64+
- for *Eclipse* import [contributing/eclipse-google-style.xml](contributing/eclipse-google-style.xml)
65+
66+
## Thanks
5467

5568
These guidelines were best on several sources, including
5669
[Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), [PurpleBooth's

0 commit comments

Comments
 (0)