Spring Fu is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.
If you have not previously done so, please fill out and submit the Contributor License Agreement.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
We use GitHub issues to track bugs and enhancements. If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
To build the source you will need to install Java 8+, and you will need a local MongoDB server to run tests and samples.
The project can be built from the root directory using the standard Gradle command:
$ ./gradlew build
With small exceptions described below Spring Fu uses official Kotlin Coding Conventions (aka Kotlin Style Guide). Description and instructions on how to set it are provided at the link above.
After following the instructions at the link above open Settings → Editor → Code style → Kotlin and on 'Tabls and Indents' tab check the 'Use tab character' checkbocks. Indentation in Spring projects is universally done with TAB character. Smart tabs must be disabled.
Documentation can be built via the following Gradle command:
$ ./gradlew asciidoctor
In order to get syntax highlighting for Kotlin code, asciidoctor-rouge needs to be installed before running the following command:
$ asciidoctor -r asciidoctor-rouge -a source-highlighter=rouge src/docs/asciidoc/reference.adoc -o build/docs/html5/reference.html