|
1 | 1 | ## How can I contribute? |
2 | 2 |
|
| 3 | +* If you think this project is great, you would like to help, but you don't know how - you can become project's stargazer. By starring you're making project more popular. Visit [this link](https://blog.github.com/2012-08-06-notifications-stars) if you would like to learn more about how notifications and stars works on Github. |
3 | 4 | * create issues for bugs you find |
4 | 5 | * create pull requests to fix bigs, add features, clean up code, etc. |
5 | 6 | * improve the documentation or the wiki |
6 | 7 |
|
7 | 8 | ## What can I work on? |
8 | 9 |
|
9 | 10 | We do not yet support the full set of Spring-Data yet: |
10 | | -[docs.spring.io/spring-data/commons/docs/current/reference/html/](http://docs.spring.io/spring-data/commons/docs/current/reference/html/) |
| 11 | +[Spring Data Reference Documentation](http://docs.spring.io/spring-data/commons/docs/current/reference/html/) |
11 | 12 |
|
12 | 13 | The issues page is another good place to look for ways to contribute. |
13 | 14 |
|
14 | 15 | ## Compatibility |
15 | 16 |
|
16 | 17 | The library is heavily based on Spring. Therefore this library should work in any environment that is supported by the underlying Spring Framework version itself. |
17 | 18 |
|
18 | | -At the time of writing this is JDK7 (binary compatibility) but at compile time JDK8 is required - therefore supporting also `Optional` etc. |
| 19 | +At the time of writing this is JDK8 (binary compatibility). |
19 | 20 |
|
20 | 21 | ## Code Style |
21 | 22 |
|
22 | | -A dedicated and holistic code style is not yet defined. |
23 | | -Changes to existing classes should follow the style that is found in that specific class. |
| 23 | +Google's Java code style is followed available [here](https://github.com/google/styleguide). |
24 | 24 |
|
25 | | -In gernal, the Google Code style should be followed. |
| 25 | +The proper formatting is checked during compile time. To easily follow the style use **one** of those options: |
| 26 | +1. Use [Eclipse Formatter](https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.user/reference/preferences/java/codestyle/ref-preferences-formatter.htm) with the `src/eclipse-java-google-style.xml` file. |
| 27 | +1. Use [IntelliJ Formatter](https://blog.jetbrains.com/idea/2014/01/intellij-idea-13-importing-code-formatter-settings-from-eclipse/) with the `src/eclipse-java-google-style.xml` file. |
| 28 | +1. Use `mvn formatter:format` to apply the style to the source files. |
26 | 29 |
|
27 | 30 | ## Merging |
28 | 31 |
|
|
0 commit comments